Open API

architecture

This item was not updated in last three versions of the Radar. Should it have appeared in one of the more recent editions, there is a good chance it remains pertinent. However, if the item dates back further, its relevance may have diminished and our current evaluation could vary. Regrettably, our capacity to consistently revisit items from past Radar editions is limited.

Nov 2019

Adopt

The OpenAPI Specification is becoming a broadly adopted industry standard for describing modern REST APIs. Other initiatives like RAML have joined the OpenAPI Initiative.

OpenAPI v2 version is basically the former Swagger - and Swagger provides useful tools for OpenAPI like the online editor and viewer http://editor.swagger.io/ We have also found that this version currently have a good tool support across languages, so you will find API client and server generation tools for a lot of languages, which makes it quite easy to connect to an API that is described in OpenAPI standard.

OpenAPI v3

OpenAPI v3 adds more features to the specification - for example the ability to describe APIs supporting request/callback pattern.

There is a very good api designer https://www.apicur.io/ and a good mock generator http://microcks.github.io/index.html

The general tool support is excellent. See https://openapi.tools/