Трябваше ли да проектирате API? Използвахте ли OpenAPI, Swagger?

Да, трябваше да проектирам API. За описание и документация на RESTful API използвах OpenAPI Specification (по-рано известен като Swagger). Това позволява формализиране на структурата на API, описание на крайните точки, методи, параметри и модели на данни, както и автоматично генериране на документация и клиентски SDK.

Пример за прост опис на крайна точка в OpenAPI (YAML):

paths:
  /users:
    get:
      summary: Вземете списък с потребители
      responses:
        '200':
          description: Успешен отговор
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/User'
components:
  schemas:
    User:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string