Ce tipuri de contracte se aplică la crearea unui API REST?

Atunci când se creează API-uri REST, se aplică următoarele tipuri de contracte:

• OpenAPI (Swagger) — standard pentru descrierea API-urilor REST, care permite documentarea și generarea de cod client.
• JSON Schema — definește structura obiectelor JSON utilizate în solicitări și răspunsuri.
• gRPC (deși nu este REST, uneori este utilizat ca și contract pentru API) — protocol cu contract bazat pe protobuf.

În contextul API-urilor REST, se folosește în principal OpenAPI, care descrie:

• Puncte finale (căi și metode HTTP)
• Formatele solicitărilor și răspunsurilor
• Parametri și anteturi
• Coduri de răspuns

Exemplu de fragment simplu de OpenAPI:

paths:
  /users:
    get:
      summary: Obține lista de utilizatori
      responses:
        '200':
          description: Răspuns de succes
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/User'