4 Using Swagger Editor to write OpenAPI definitions

This chapter covers

  • Introducing Swagger Editor
  • Writing the smallest OpenAPI definition in Swagger Editor
  • Adding GET /reviews from the last chapter into our definition
  • Interacting with the API in Swagger Editor

OpenAPI definitions have a lot of nuances that most of us can’t be bothered to learn right away. This is often the way of the developer—jumping into a new technology and trying to hack it out until it looks right and hopefully works. However, we often stumble and end up reading the documentation anyway, just enough to get the job done. A better approach is to try to minimize the amount of documentation we actually need to know by building tools that can help guide our actions.

Swagger ...

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.