Summary

In this chapter, we covered the concept of generating prototypes for our API as a final step before committing resources and time to writing the actual code to implement our 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. We learned how to use OAS document elements such as info, components, and paths to build up the definitions of our endpoints, as well as how to use parameters, requestBodies, and responses to fill in the details of each API URL and method in our prototype.

Finally, we learned to use the SwaggerHub Editor to do our live editing, generate our mock server for prototype testing, and generate technical API documentation. We also learned how to use the external documentation generator ReDocly to quickly and easily create interactive API documentation from our OAS file.