8 Preparing and hosting API documentation
This chapter covers
- Adding metadata to our API definition
- Writing a description in Markdown
- Grouping operations together using tags
- Hosting our API documentation online using Swagger UI and Netlify.com
In this chapter we’re going to take our OpenAPI definition and turn it into online documentation (see figure 8.1). Before hosting it online, we’ll add some human touches, such as API metadata, rich text descriptions, and operation tags. These touches will make it a lot easier for our users to consume.
Figure 8.1 Where we are
So far we’ve only been describing the bare essentials of the API, such as what ...
Get Designing APIs with Swagger and OpenAPI now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.
