Choosing HTTP status codes Series - Part 1
This is not the HTTP method you're looking for, HTTP status code 404 vs 405 vs 501
By Arnaud Lauret, April 21, 2021
When designing APIs, choosing HTTP status codes is not always that obvious and prone to errors, I hope this post series will help you to avoid common mistakes and choose an adapted one according to the context.
This first post answers the following question: given that a
GET /resources/123 request returns a
200 OK, what should be the response to
DELETE /resources/123 if
DELETE method is not implemented?
404 Not Found,
405 Method Not Allowed or
501 Not Implemented?
When unicorn poop hits the fan (or how APIs can improve how we build software)
By Arnaud Lauret, April 14, 2021
Do you know what happens when you throw unicorn poop into a fan? It makes everything better, everyone and everything around looks perfect, covered with joy and happiness. Working seriously on (public or private) APIs can lead to the same kind of effect on how we build software. Why? Because modern web APIs raises the bar of software design and developer experience and so raises awareness and expectations regarding these topics for software in general.
Batch (Github) API calls with CSV and Postman runner and visualizer
By Arnaud Lauret, April 7, 2021
Do you need to make a repetitive task that could be done through an API instead of a UI? Do you need to make many API calls but don’t want to code? This post is made for you: you’ll learn to use Postman and CSV files to batch API calls. You may also learn a thing or two about API design, Github APIs (yes, plural) and other Postman features (variables, security, command line, visualizer, …) in the making. If you never have used Postman or Github APIs, no problem, everything will be explained.
7 ways leading to wrong ownership and killing APIs
By Arnaud Lauret, March 28, 2021
After hundreds of API design reviews, I can tell that the most neglected aspect of API governance is ownership. Unfortunately, that’s probably the most important one. Without true ownership, your APIs will probably be totally wrong. Without true ownership, your employees will be terribly sad or leave. Without true ownership, your company may even die. As an API design reviewer, I believe that my role is also to warn the teams I’m working with about this topic and help them to fix the problem.
API Days Interface 2020 Series - Part 2
Doing APIs right and doing right APIs
By Arnaud Lauret, July 26, 2020
API Days Interface being online made the experience a bit different but after 3 days, I felt almost as usual; exhausted and my brain boiling. In previous post, I shared my feelings about my first online conference. Now let’s talk about the content; Sam Newman doing a facepalm, API design, architecture, governance and my new favorite quote “Doing APIs right, doing right APIs”.
API Days Interface 2020 Series - Part 1
Speaking into the void
By Arnaud Lauret, July 8, 2020
I’ve attended and spoke at API Days Interface online conference on June 20, July 1 & 2, 2020. Being online made the experience a bit different but after almost 3 days, I felt almost as usual; exhausted and my brain boiling with all what I’ve heard and seen. In this first post I share my feelings about attending and speaking at an online conference.
JQ and OpenAPI Series - Part 4
Bonus: Coloring JQ's raw output
By Arnaud Lauret, July 6, 2020
Ever wanted to quickly find, extract or modify data coming from some JSON documents on the command line? JQ is the tool you’re looking for. The three previous parts of this JQ and OpenAPI Series, taught us to extract data from JSON (OpenAPI) files and modify them using many filters, creating modules and using command line arguments. To finish this series, we’ll learn to color JQ’s raw terminal output and do a colored version of part 2’s search operations.
JQ and OpenAPI Series - Part 3
Modifying OpenAPI files with JQ
By Arnaud Lauret, June 28, 2020
Ever wanted to quickly find, extract or modify data coming from some JSON documents on the command line? JQ is the tool you’re looking for. Thanks to the two previous parts of this JQ and OpenAPI Series, we learned how to extract data from JSON (OpenAPI) files by discovering many filters, creating modules and using command line arguments. Now we will discover how to modify them; how to replace, add or delete elements in processed documents.
JQ and OpenAPI Series - Part 2
Using JQ command line arguments, functions and modules
By Arnaud Lauret, February 3, 2020
Ever wanted to quickly find, extract or modify data coming from some JSON documents on the command line? JQ is the tool you’re looking for. In the previous part of this JQ and OpenAPI Series, we learned to invoke JQ and how to extract data from JSON documents using some of its many filters. Now we will discover how to build flexible and easily reusable JQ filters by creating functions and modules and also using command line arguments.
JQ and OpenAPI Series - Part 1
Using JQ to extract data from OpenAPI files
By Arnaud Lauret, January 15, 2020
Ever wanted to quickly find, extract or modify data coming from some JSON documents on the command line? JQ is the tool you’re looking for. In this 4 parts post series, you’ll discover why and how I use JQ with OpenAPI Specification files. But more important, you’ll get some basic and more advanced example of how to use JQ on any JSON document to get and modify JSON data as you want. In this first part we’ll focus on what is JQ, why I use it with OpenAPI files and we’ll learn how to invoke JQ and discover some of the many JQ filters that can be used to extract data from JSON.