Let me introduce you to OpenAPI
Let me introduce you to OpenAPI
By Maarten Van Hoof
5 min read
OpenAPI allows us to improve effeciency between teams and interdependent projects. It allows us to describe our API in a single document. In this part of the series, we will take you through the most important parts of an OpenAPI document.
Part of series
In the previous part of this series, we introduced you to the purpose of contracts between API providers and consumers. This visibility allows us to improve efficiency between teams and interdependent projects, wether that be internal or external projects.
Let us walk you through a few sections of an OpenAPI document, the ones that will most likely the largest part of your document and where most of the information is stored.
OpenAPI files can be written in both JSON and YAML format. For brevity, we will use the YAML format.
# Specification version
# General API metadata
# Server information. BaseURLs, environments, ...
# Available paths & operations
# Datamodel abstraction
# Security mechanisms can be used across the API
# Grouping of paths & components
# Additional external documentation
external docs: ...
# Webhook operations, similar to paths, only API is now a consumer.
On the first level, we describe a few general sections and properties. First, we need to declare our OpenAPI version. This is to ensure compatibility with certain types of tooling.
Next, we can declare some general information with the info property. Who has written this document, where to contact the authors, etc.
In the servers section, we can declare multiple base URLs on which the API will be available. For instance, when you have various environments available.
The first major section of a typical OpenAPI document is the paths section. Here we describe our operations, which are a combination of paths and HTTP methods. These operations describe the required data that the consumer has or can provide, like query string parameters, URL parameters, request bodies and the data that the API can respond with, status codes, content types, and data formats.
The second major section is the components section. The OpenAPI specification extends the JSON schema specification. It allows us to reuse parts of our internal and external documents with the power of JSON schema references. In the components section, we can abstract and define data models that we can refer to from our operations.
We define the security mechanisms to which our API validates the consumer in the security section, and link each mechanism to the operations needing a specific mechanism.
In the tags section, we can add taxonomy to group our operations, provide links to external documentation and declare webhooks where the API now becomes a consumer itself.
Furthermore, we can add external documentation to our API if the format of this document does not suffice your needs, and we can declare webhooks where the API now becomes a consumer itself.
summary: List all pets
summary: Create a pet
summary: Info for a specific pet
In paths, we first declare the URL the operation is available on, next the HTTP method. The combination of a URL and an HTTP method is called an operation in the OpenAPI context.
# A unique identifier for this operation. Mostly used in OpenAPI tooling.
# A short summary of what the operation does
summary: List all pets
# A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.
- name: limit
# It is a query string parameter
# A more thorough description of what this parameter does to a request
description: Limit how many pets this API will return.
# It is not required
# It must be an 32-bit integer
In an operation, we can declare the parameters or requestBody it should or can receive and how it should respond. We can also declare an operationId, which most tooling uses as an identifier for other functionalities, a summary or description to better describe the functionality this operation offers, which security schemes this operation has to adhere to, etc.
description: Expected response to a valid request
description: unexpected error
We declare an operation response by stating a status code or the keyword default for a default response an operation should return when the defined status codes don't suffice. Very handy to declare a default error response that produces the same error format for all erroneous status codes.
Then we declare the Content-Type with which the provider will respond. RESTful APIs aren't limited by responding only in JSON. XML, plain text, HTML, and also binaries are possible Content-Types one can define.
Next, we'll define the data model with which our API provider will respond. This can be the entire definition of a component at once or a reference to a component defined in the root-level section Components.
The OpenAPI specification extends the JSON schema specification and allows us to use one of its powerful features: References. With references, we can refer to other parts of the document or refer to parts of external documents. References are declared with the
I'll explain more about the declaration of data models in the next section, but for now, we'll just use a reference to a component.
In the components object, we can describe data models we can reuse throughout our document thanks to JSON schema references' power with the $ref keyword. More information about the $ref keyword can be found here. It allows us to keep our OpenAPI document a bit cleaner, with less repetition and more DRY.
The Components object has several fixed fields to subcategorise the type of component we declare.
schemas: Input and output data types.
responses: Response objects
parameters: Operation parameters; path, query-string, ...
examples: Example objects that can describe more realistic data
requestBodies: RequestBody objects
headers: Header objects
securitySchemes: securitySchemes Objects ...
In the schema object, we describe a document's most atomic level of data objects: our responses' input and output types, requestBodies, parameters, etc.
For example, we describe our Pet as an object. It has the properties id, name, image, and tag. All, except id, are described as values of the type string. Id is defined as a 64-bit integer. Id and name are described as required, meaning API consumers should consider that the image and tag value could not be in the returned data. We can reuse our Pet component to create a Pets component, an array of the Pet component.
In this article, we've seen how to define an OpenAPI document. We've seen how to define the metadata of our API, the operations it offers, the responses it can return, and how to define and reuse the data models it uses.
In the next part of this series, we'll show you ways of integrating OpenAPI in to your team and project workflows.