API Handyman

{"input" : "learn", "output" : "share"}

The API Stylebook

I’m a thrilled to announce that apistylebook.com is now online.

The API Stylebook aims to help API Designers to solve API design matters and build their API design guidelines by providing quick and easy access to selected and categorized resources.

Read more on the API Stylebook blog

Writing OpenAPI (Swagger) Specification Tutorial - Part 8 - Splitting specification file

With previous posts we have learned to produce an OpenAPI specification containing all OpenAPI specification subtleties. Some specification files may become quite large or may contain elements which could be reused in other APIs. Splitting a specification file will help to keep it maintainable by creating smaller files and also help to ensure consistency throughout APIs by sharing common elements.

Read more

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