Posts

The API Handyman writes as time permits

How public web APIs raise software bar

While answering some question on my Design of Everyday APIs book’s forum, I wrote:

Now that I have seen brilliant Web APIs that can be used so easily because of their design but also the overall experience some can provide (the famous “DX”) I have become far more demanding and challenging with software in general

Yes. Public web APIs definitely raise software bar. The whole software industry should take example on them …

Read more

The story behind The Design of Everyday APIs book

I’m thrilled to announce that I’m writing a book about API design: The Design of Everyday APIs. This book is published by Manning Publications and the first two chapters are now available on the Manning Early Access Program or MEAP (affiliate link, use fcclauret discount code to get 37% off). This book is for everyone who wants to learn API design. But, what’s the story behind this book about API design? To answer this question, let’s talk about my other passion: guitar.

Read more

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

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

...And GraphQL for all? A few things to think about before blindly dumping REST for GraphQL

GraphQL is new. GraphQL is cool. Look! Github dumped REST for it! We MUST do it too!
Well, why not. GraphQL could be a great tool, but like any tool, you don’t choose it just because. You choose it because it solves a problem in a given context. You choose it knowing its strengths and weaknesses.

While discovering what is GraphQL we will see what REST API providers should think about before blindly dumping REST for it. From design and implementation to pricing model and analytics down to developers experience and implementations, choosing an API design style will have impact on the whole API lifecycle. Therefore, this choice must be an enligthned one and not based on simple beliefs.

Read more