concept schemas in category swagger

appears as: schemas
Designing APIs with Swagger and OpenAPI

This is an excerpt from Manning's book Designing APIs with Swagger and OpenAPI.

The YAML specification itself is quite large and comes in different flavours (or schemas). OpenAPI focuses on the bare minimum for its needs, which is the JSON Schema of YAML version 1.2. yaml.org/spec/1.2/spec.html.

If you look at the HTTP method GET and the URL /reviews, you can read it as "Get Reviews". This is a "Get" action taken on the reviews concept in the domain model. The functionality or behavioral parts of the domain model are represented through the API operations in OpenAPI. We will look at operations later in this chapter and focus on schemas first.

In chapter 7 you have already seen this element where we used it to create a security scheme definition for the API. Now, we use components and its sub-element schemas to define reusable schemas for the API. After adding these container elements, your OpenAPI file should look like this:

Listing 10.4. PetSitter OpenAPI with schemas
openapi: 3.0.0
info:
  title: PetSitter API
  version: "0.1"
paths: {}
components:
  schemas: {}