API Handyman

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

Deliveroo API Design Guidelines added to the API Stylebook

I’ve added the Deliveroo API Design Guidelines to the API Stylebook.

These guidelines are definitely a MUST read for any API designer.

To discover this API design guide and a short review, let’s go to the API Stylebook blog.

API Design Tips And Tricks - Getting, creating, updating or deleting multiple resources in one API call

Getting, creating, updating or deleting multiple resources in a single API call is a common need in REST APIs. But how to achieve that in a consistent way accomodating how we work with a single resource and REST principles? This is what we’ll see in this post.

Read more

OpenAPI Visual Documentation updated with 3.0.0-rc0

The OpenAPI Visual Documentation has been updated. The new version 3.0.0-rc0 of the OpenAPI specification has been added. The addition brings a fully detailed change log of what has change from version 2.

Read more

Google API Design Guide added to the API Stylebook

I’ve just added the Google API Design Guide to the API Stylebook.

This guide is slightly different from the other ones because it deals with REST and RPC API design focusing on gRPC APIs using Protocol Buffers v3.

To discover this API design guide and a short review, let’s go to the API Stylebook blog.

Writing OpenAPI (Swagger) Specification Tutorial - Part 9 - Extending the OpenAPI specification

This is the end, my OpenAPI friends, the end. The end? Not really. This last part of the OpenAPI tutorial is a new beginning. With previous parts we have learned to master the OpenAPI specification but there’s a last thing to learn to unleash its full power: extensions. This format is easily extensible, it allows to add custom data within an API description. But for what purposes? Let’s have a glimpse of these extensions endless possibilities.

Read more