What does a web application framework need to offer API developers in 2020 in order to meet the demands and keep up with modern practices?
Short version: JSON Schema Draft 2019/09 was published, and OpenAPI v3.1 looks likely to have #1977 included - which brings full JSON Schema Draft 2019/09 support. So when will OpenAPI v3.1 come out? Tough to say, but there is talk of maybe getting an RC1 out in a few weeks, and the more complex things like overlays may well be punted to a later RC, or v3.2. Things are looking incredibly positive.
Two months ago I teased that Stoplight was about to release something big, and yesterday we announced Stoplight Studio - an OpenAPI and standalone JSON Schema editor, which just so happens to be visually stunning and completely free.
This blog has been a bit quiet for the last two years, with me blogging on APIs You Won't Hate and phil.bike more than here.
A while back I wrote an article called Understanding RPC, REST and GraphQL which outlined the "what" in how these various approaches differ. This got a few people thinking I was saying REST was drastically superior in all ways, which is a common conclusion when folks hear me describe REST as a layer of abstractions on top of RPC… More abstractions does not mean definitively "better", sometimes that's going to be overkill, so let's look at when you might want to use which.
API Evolution is making a comeback these days with GraphQL and gRPC advocates shouting about it. Whatever API paradigm or implementation you subscribe to, evolution is available to you. REST advocates have been recommending API evolution for decades, so let's take a look at how that can work.
My previous article explained the divergence between OpenAPI and JSON Schema (a.k.a the subset/superset/sideset problem), and promised solutions. One of those solutions is a tangible thing, which you can install right now! The other is now ready for tool vendors to start considering.
This article is going to explain the divergence between OpenAPI and JSON Schema, which I've been calling the subset/superset/sideset problem. It'll finish up explaining how we're going to solve it, and ~I'll write part 2 when it is solved~ part two explains the solution.
Back in October I wrote Chasing the Perfect API Specification Workflow, which was a huge article about the state of the API specification world. One person trying to figure out a good workflow, in a sea of alternative specifications, with incomplete tooling, making it hard to see a solution for all the partial bits of functionality.
The misunderstandings on REST continue, and I'm happy to explain them all up!