Шумо дар тавсифи OpenAPI мустақим нависед?

Бале, OpenAPI спецификацияси API-ни тўғридан-тўғри YAML ёки JSON форматларида тасвирлашга имкон беради, у ерда йўллар, усуллар, параметрлар, маълумот схемалари ва жавоблар батафсил кўрсатилади. Бу API-ни ҳужжатлаш ва стандартлаштириш, шунингдек, мижоз кодлари ва тестларни яратиш учун қулай усул. Масалан, бир эндпоинтни шундай тасвирлаш мумкин:

paths:
  /users:
    get:
      summary: Фойдаланувчилар рўйхатини олиш
      responses:
        '200':
          description: Муваффақиятли жавоб
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/User'