Google API Design Guide added to the API Stylebook
By Arnaud Lauret, March 5, 2017
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 Series - Part 9
Extending the OpenAPI specification
By Arnaud Lauret, February 19, 2017
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.
...And GraphQL for all? A few things to think about before blindly dumping REST for GraphQL
By Arnaud Lauret, January 22, 2017
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.
Dr Jekyll and Mr API Handyman
By Arnaud Lauret, December 23, 2016
ICYMI, I’ve just switched from a self hosted Wordpress to a Jekyll static website hosted on Github. The code is available in the apihandyman.io repository. If you’re looking for information and tips about how to enable pagination on categories pages and have infinite scroll with Jekyll or how to to deploy a Jekyll website using custom plugins on Github Pages, you should take a look at it.
Read Evolving a Company’s IS in the Lego Computing Age on Nordic APIs blog
By Arnaud Lauret, December 6, 2016
If you wonder how to evolve a company’s IS in the lego computing age, read my post on Nordic APIs blog.
People First: A not so gonzo API Strat Boston 2016 coverage
By Arnaud Lauret, November 19, 2016
The last API Strat 2016 day, after the last talk, a man living in kentucky asked me something like What is the one thing you will remember about this conference?. I answered something like People First.
People First. This is definitely what sticks in my mind after this conference.
The API Stylebook
By Arnaud Lauret, September 10, 2016
Writing OpenAPI (Swagger) Specification Tutorial Series - Part 8
Splitting specification file
By Arnaud Lauret, August 2, 2016
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.
Writing OpenAPI (Swagger) Specification Tutorial Series - Part 7
By Arnaud Lauret, June 12, 2016
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.