Описание директно в спецификацията OpenAPI?

Да, спецификацията OpenAPI позволява да се описва API директно във формат YAML или JSON, където подробно се посочват пътищата, методите, параметрите, схемите на данните и отговорите. Това е удобен начин за документиране и стандартизиране на API, както и за генериране на клиентски код и тестове. Например, може да се опише един ендпойнт така:

paths:
  /users:
    get:
      summary: Вземете списъка с потребители
      responses:
        '200':
          description: Успешен отговор
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/User'