Quali tipi di contratti vengono applicati durante la creazione di un'API REST?

Durante la creazione di un'API REST vengono applicati i seguenti tipi di contratti:

• OpenAPI (Swagger) — standard per descrivere le API REST, che consente di documentare e generare codice client.
• JSON Schema — definisce la struttura degli oggetti JSON utilizzati nelle richieste e risposte.
• gRPC (anche se non è REST, viene talvolta usato come contratto per API) — protocollo con contratto basato su protobuf.

Nel contesto delle API REST, si utilizza principalmente OpenAPI, che descrive:

• Endpoint (percorsi e metodi HTTP)
• Formati di richieste e risposte
• Parametri e intestazioni
• Codici di risposta

Esempio di un semplice frammento di OpenAPI:

paths:
  /users:
    get:
      summary: Ottieni la lista degli utenti
      responses:
        '200':
          description: Risposta riuscita
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/User'