DEV Community

Cover image for Seriously, Write Your API Spec First

Seriously, Write Your API Spec First

Allen Helton on September 27, 2023

Many application developers are API builders in one way or another. Whether they are building APIs for 3rd party integrators, user interfaces, or a...
Collapse
 
blakeanderson profile image
Blake Anderson

An interesting approach that takes this idea a step further: write the core sample data, and generate the API spec from there. This provides an even more concise format to flesh out the the API spec and is useful as fixtures for testing as well.

Collapse
 
iamaashishpatel profile image
Ashish Patel

Stripe is the best example of providing simple and concise API documentation.