Introduction to SwaggerHub
Explore the basics of SwaggerHub and how to create OpenAPI Specification documents for prototyping APIs. Learn to set up and edit OAS files, understand key sections, and use SwaggerHub’s tools to streamline the API design process.
We'll cover the following...
The engineering document we’ll use to prototype our API is an OAS document. The advantage of OAS documents is that they’re easy to create and edit. There are also several supporting tools that can read OAS documents and generate things like server-side sample code, API client applications, and human-readable documentation. These are all great shortcuts or prototypes that we can use to validate our design before committing expensive resources to build the production version of our API.
OAS documents have a well-defined structure. An OAS file includes three main sections at the top level:
- The
infosection holds identifying information such as the title, a brief description, and some additional identifying data. - The