Musel jste navrhnout API? Použil jste OpenAPI, Swagger?

Ano, musel jsem navrhnout API. Pro popis a dokumentaci RESTful API jsem použil OpenAPI Specification (dříve známý jako Swagger). To umožňuje formalizovat strukturu API, popsat endpointy, metody, parametry a datové modely, a také automaticky generovat dokumentaci a klientské SDK.

Příklad jednoduchého popisu endpointu v OpenAPI (YAML):

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'
components:
  schemas:
    User:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string