Building RESTful APIs?
Great – API consumers love them if the right design decisions were made. And we need to make a lot of design decisions when building a new API.
How do we capture the REST design decisions?
How do we gain an overview, communicate the decisions and iterate on the design? To describe APIs in a precise manner, API designers typically use API description languages. They offer specialized language concepts to capture design decisions. Thus, API description languages can be called the power tools of the API designer.
Which API Description Language should we use?
One of the most popular API description languages is OpenAPI 2.0 – also known as Swagger 2.0. In this quick guide, we will learn how Swagger/OpenAPI can be used to capture your RESTful API design decisions.
What is the API-University Series?
The API-University Series is a modular series of books on API-related topics. Each book focuses on a particular API topic, so you can select the topics within APIs, which are relevant to you.
Keywords: API Description Language, Swagger, OpenAPI, REST, API, Design, Design Decisions
Get the Book
Title: Swagger & OpenAPI 2.0 Quick Guide