Posts

The API Handyman writes as time permits

Writing OpenAPI (Swagger) Specification Tutorial - Part 7 - Documentation

Previous posts showed how to write a highly accurate description of an API interface contract with the OpenAPI specification. But an interface contract, no matter how brilliant, is nothing without some explainations. A fully documented OpenAPI specification file can provide some useful information and be used as a part of an API’s documentation.

Read more

Writing OpenAPI (Swagger) Specification Tutorial - Part 6 - Defining Security

After mastering input and output modeling like a Jedi, let’s see how we can describe API’s security with the OpenAPI specification’s.

Read more

Writing OpenAPI (Swagger) Specification Tutorial - Part 5 - Advanced Input And Output Modeling

After learning how to create an accurate data model, we continue to delve into the OpenAPI specification’s and discover how to describe tailor made API’s inputs and outputs.

Read more

Writing OpenAPI (Swagger) Specification Tutorial - Part 4 - Advanced Data Modeling

After learning how to simplify specification files, let’s start delving into the OpenAPI specification’s and discover how to describe a high accuracy API’s data model.

Read more

Writing OpenAPI (Swagger) Specification Tutorial - Part 3 - Simplifying specification file

After learning the basics and having written a little bit huge file for a so simple API, you may be concerned by what nightmare it could be to handle a bigger and more complex API. REST assured that the OpenAPI Specification (formerly Swagger Specification) format offers all means to write really small and simple specification files whatever the described API’s size and complexity.

Read more