How does JSON description align with OpenAPI?

OpenAPI is a specification for describing REST APIs that uses JSON or YAML to structure the API description. In OpenAPI, data (payload) descriptions are often defined using JSON Schema, which allows precise definition of data structure, types, and constraints that the API accepts or returns.

In other words, JSON Schema serves as a language for describing the structure of JSON objects, and OpenAPI uses these schemas to formalize API contracts. This enables automatic generation of documentation, validation of requests and responses, as well as the creation of client and server SDKs.

An example fragment of an OpenAPI with a JSON schema description:

components:
  schemas:
    User:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
      required:
        - id
        - name