Kokie sutarties tipai taikomi kuriant REST API?

Kuri kuriant REST API, taikomi šie sutarčių tipai:

• OpenAPI (Swagger) — standartas REST API aprašymui, leidžiantis dokumentuoti ir generuoti kliento kodą.
• JSON Schema — apibrėžia JSON objektų struktūrą, naudojamą užklausose ir atsakymuose.
• gRPC (nors tai nėra REST, kartais naudojama kaip API kontraktas) — protokolas su kontraktu, pagrįstu protobuf.

REST API kontekste dažniausiai naudojamas OpenAPI, kuris aprašo:

• Galinius taškus (kelius ir HTTP metodus)
• Užklausų ir atsakymų formatus
• Parametrus ir antraštes
• Atsakymo kodus

Pavyzdys paprasto OpenAPI fragmento:

paths:
  /users:
    get:
      summary: Gauti naudotojų sąrašą
      responses:
        '200':
          description: Sėkmingas atsakymas
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/User'