"What do you want to do with your APIs, and how do you want to do it? And what are the rules of your domain? Why do you name it like that? Is it? I say these things every day. If you want to be a good API design reviewer, you must not be afraid to ask stupid questions, and it's really for the better. If you don't have discoverability of your APIs, you could be in trouble."
Some members of the Stoplight community may have noticed that we are practicing a celebration of “Style Guide September” this month at Stoplight. So, it felt fitting to invite my colleague, Arnaud Lauret (the API Handyman), on to API Intersection to discuss style guide best practices. As the author of the API stylebook and the novel “Design of Web APIs,” this Natixis Senior API Architect was the perfect guest for this topic.
In our recent podcast episode, we covered the six major style guide tips that will improve your developer experience and level-up your API design.