Building an API Product by Building an API Product

Author:Building an API Product
Language: eng
Format: epub
Publisher: Packt Publishing Pvt Ltd
Published: 2024-01-16T00:00:00+00:00

OpenAPI

This is probably the most popular API specification format. OpenAPI started with a different name. It was created in 2010 with the name of Swagger. In 2015, its original creators donated Swagger to the Linux Foundation, which renamed it to OpenAPI. Since then, OpenAPI has evolved, and the two major versions in use today are versions 2 and 3. OpenAPI is a fundamental element in the definition of REST APIs, since it offers a machine-readable format – using either JSON or YAML – that can be used to generate documentation and API client and server code, and it works with a wide range of programming languages and frameworks.

You saw an example of what an OpenAPI definition document looks like in Chapter 5. The example was written in YAML and defined a payments API. Later in this chapter, you’ll take that example and rewrite it in JSON to see what that’s like.

Download

Copyright Disclaimer:
This site does not store any files on its server. We only index and link to content provided by other sites. Please contact the content providers to delete copyright contents if any and email us, we'll remove relevant links or contents immediately.