Que tipos de contratos são aplicados na criação de uma API REST?

Ao criar uma API REST, aplicam-se os seguintes tipos de contratos:

• OpenAPI (Swagger) — padrão para descrever APIs REST, que permite documentar e gerar código cliente.
• JSON Schema — define a estrutura dos objetos JSON utilizados em pedidos e respostas.
• gRPC (embora não seja REST, às vezes é usado como contrato para API) — protocolo com contrato baseado em protobuf.

No contexto de APIs REST, usa-se principalmente OpenAPI, que descreve:

• Endpoints (caminhos e métodos HTTP)
• Formatos de pedidos e respostas
• Parâmetros e cabeçalhos
• Códigos de resposta

Exemplo de um fragmento simples de OpenAPI:

paths:
  /users:
    get:
      summary: Obter lista de utilizadores
      responses:
        '200':
          description: Resposta bem-sucedida
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/User'