Kādi līgumu veidi tiek piemēroti, izveidojot REST API?

Veido REST API izveidi, tiek izmantoti šādi līgumu tipi:

• OpenAPI (Swagger) — standarts REST API aprakstīšanai, kas ļauj dokumentēt un ģenerēt klienta kodu.
• JSON Schema — definē JSON objektu struktūru, kas tiek izmantota pieprasījumos un atbildēs.
• gRPC (lai gan tas nav REST, dažreiz tas tiek izmantots kā līgums API) — protokols ar līgumu, balstītu uz protobuf.

REST API kontekstā galvenokārt tiek izmantots OpenAPI, kas apraksta:

• Galapunktus (ceļus un HTTP metodes)
• Pieprasījumu un atbilžu formātus
• Parametrus un galvenes
• Atbilžu kodus

Vienkāršs OpenAPI fragmenta piemērs:

paths:
  /users:
    get:
      summary: Saņemt lietotāju sarakstu
      responses:
        '200':
          description: Veiksmīga atbilde
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/User'