Automated Style Guides for REST, GraphQL and gRPC

Phil Sturgeon
Nov 5 · 8 min read

Ask 100 developers where a semicolon should go, and you’ll either get 100 answers, or a all-on-all fist fight. To save this from happening at work, most folks implement a style guide, which beyond helping with consistent style to avoid new developers getting shouted at for “doing it wrong”. Linters can advise best practices, shout about things which are technically allowed but likely to cause trouble, and shape the API of code as it’s being written (snake_case that method!) This is always done for code, and is becoming increasingly popular for API descriptions.

Keep the story going. Sign up for an extra free read.

You've completed your member preview for this month, but when you sign up for a free Medium account, you get one more story.
Already have an account? Sign in

Phil Sturgeon

Written by

Building API design tools @stoplightio , teaching at @apisyouwonthate , and cycling around Europe raising awareness for carbon offsetting.

APIs You Won't Hate

Everyone And Their Dog Wants An API, So You Should Probably Learn How To Build Them.

Welcome to a place where words matter. On Medium, smart voices and original ideas take center stage - with no ads in sight. Watch
Follow all the topics you care about, and we’ll deliver the best stories for you to your homepage and inbox. Explore
Get unlimited access to the best stories on Medium — and support writers while you’re at it. Just $5/month. Upgrade