Technology Radar TemplateTechnology Radar Template

Open API

architecture
Adopt

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

OpenAPI v3

The current version, OpenAPI v3, added more features to the specification, for example, the ability to describe APIs supporting request/callback patterns.

There is a very good API designer: Apicurio and a good mock generator: Microcks.

The general tool support is excellent. See OpenAPI Tools.

TM Forum Open API

The TeleManagement Forum (TM Forum) has introduced its own set of Open APIs to foster interoperability and standardization within the telecommunications industry. The TM Forum Open API initiative provides a suite of REST-based APIs designed to accelerate the digital transformation of service providers and their ecosystem partners. These APIs cover a wide range of business scenarios and operational areas, such as customer management, product management, and service activation.

The TM Forum's Open API specifications aim to ensure that diverse systems can interoperate seamlessly, promoting agility and reducing integration costs. The comprehensive documentation and resources provided by TM Forum are instrumental in helping organizations adopt and implement these APIs effectively.

For more information on the TM Forum Open API, visit the following resources:

These additions from TM Forum further enhance the value of the OpenAPI Specification by providing industry-specific standards that help streamline telecommunications operations.

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/