Sim, a especificação OpenAPI permite descrever a API diretamente em formato YAML ou JSON, onde são indicados detalhadamente os caminhos, métodos, parâmetros, esquemas de dados e respostas. É uma forma conveniente de documentar e padronizar a API, bem como de gerar código cliente e testes. Por exemplo, pode-se descrever um endpoint assim:

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

Anterior Próximo