Vytvorili ste API dokumentáciu pomocou Swagger alebo podobných nástrojov?

Áno, vytvoril som dokumentáciu API pomocou Swagger (OpenAPI). Tento nástroj umožňuje popísať REST API vo formáte YAML alebo JSON a následne automaticky generuje interaktívnu dokumentáciu, ktorú je možné použiť na testovanie a zoznámenie sa s API.

Príklad jednoduchého popisu API v Swagger YAML:

openapi: 3.0.0
info:
  title: Príklad API
  version: 1.0.0
paths:
  /používatelia:
    get:
      summary: Získať zoznam používateľov
      responses:
        '200':
          description: Úspešná odpoveď
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: integer
                    name:
                      type: string

Tento prístup uľahčuje údržbu a pochopenie API ako pre vývojárov, tak aj pre testerov.