Jah, OpenAPI spetsifikatsioon võimaldab API-d otse kirjeldada YAML või JSON formaadis, kus üksikasjalikult on näidatud teed, meetodid, parameetrid, andmeskeemid ja vastused. See on mugav viis dokumenteerida ja standardiseerida API-d ning genereerida kliendikoodi ja teste. Näiteks võib kirjeldada endpointi järgmiselt:

paths:
  /users:
    get:
      summary: Saada kasutajate nimekiri
      responses:
        '200':
          description: Edukas vastus
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/User'

Eelmine Edasi