Ano, specifikace OpenAPI umožňuje přímo popisovat API ve formátu YAML nebo JSON, kde jsou podrobně uvedeny cesty, metody, parametry, datové schémata a odpovědi. Je to pohodlný způsob, jak dokumentovat a standardizovat API, stejně jako generovat klientský kód a testy. Například lze popsat endpoint takto:

paths:
  /users:
    get:
      summary: Získat seznam uživatelů
      responses:
        '200':
          description: Úspěšná odpověď
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/User'

Předchozí Další