Some API developers use API descriptions to plan the interface of an API before building it, which is known as the "API design first" workflow. Others build the API then generate (or manually produce) API descriptions later, which is the "code-first" workflow. We wrote API Design-first
Updated 2019-05-29: OpenAPI v3.1 has dropped SemVer, so a few things that were going to be deprecated are now just straight up removed. This post has been updated to reflect that. Updated 2021-01-10: JSON Schema released Draft 2020-12 which clarified a few edge cases, it's not a
Hi! My name is Evert, and for a while now I've been working on a project called Ketting, which is a generic Hypermedia/HATEOAS client for Javascript. I just released version 5.0, and thought it might be interesting to share the new features that have been added
Ask 100 developers where a semicolon should go, and you'll either get 100 answers, or a all-on-all fist fight. To save this from happening at work, most folks implement a style guide, which beyond helping with consistent style to avoid new developers getting shouted at for "doing
OpenAPI is thoroughly mainstream now with most modern API providers producing a description of their API for both internal and external use. There are a few features that are still without widespread traction, and the callbacks feature is one of those. It's a feature with wide appeal that
With API descriptions rising in popularity, the main question I hear folks asking about is "API Design-first" or "code-first". This is a bit of a misleading question because these are not two unique things, there are a few variants. Code-First, Write Docs "When We Have
This is a guest post by Marc-Andre Giroux and a preview of a book on GraphQL he's working on. If you're interested you can check it out and subscribe here If you've followed the discussions around whether GraphQL is a good idea or not,
One problem with building applications that talk to external dependencies like APIs, is that the applications are talking to external dependencies. This opens up a whole can of worms when it comes to testing the application. You may well have heard developers saying: don’t let tests hit external dependencies!
Validation can mean a lot of things, but in API land it generally means figuring out if the data being sent to the API is any good or not. Validation can happen in a lot of different places - it can happen on the server, and it can happen in
Nobody out there thinks you should always use REST for every single API being built, nor should you ever use any one paradigm for everything, but a growing number of people misunderstand REST so badly they think they never need it. As with most things, there is a whole bunch
Background Logging in to a web service used to mean sending a username and password and getting a cookie in return. This cookie is then sent with every request so that the server knows who is making the request. However, when it became more common for services to interact with
Dealing with the Happy Path™ in an API is pretty easy: When a client asks for a resource, show them the resource. When they trigger a procedure, let them know if it was triggered OK, and maybe if it completed without a problem. What to do when something doesn’t