Design and Build Great Web APIs

What’s Next?

In this chapter, we covered the concept of generating prototypes for your API as a final step before committing resources and time to writing the actual code to implement your design. For our API work, we used OpenAPI Specification (OAS), formerly known as Swagger, to build up our working prototype in detail from our initial design. You learned how to use the OAS document elements info, components, and paths to build up the definitions of our endpoints, and how to use parameters, requestBodies, and responses to fill in the details of each API URL and method in our prototype.

Finally, you learned to use the SwaggerHub editor to do our live editing, generate our mock server for prototype testing, and generate technical API documentation. ...