Что такое Swagger

Swagger — это набор инструментов для проектирования, документирования и тестирования RESTful API. Основные компоненты:

• OpenAPI Specification (OAS) — стандарт описания API в формате YAML/JSON.
• Swagger UI — интерактивная веб-документация API с возможностью отправки запросов.
• Swagger Editor — редактор для написания спецификаций.
• Swagger Codegen — генерация клиентских библиотек и серверного кода из спецификации.

Пример описания API в OpenAPI 3.0 (YAML):

openapi: 3.0.0
info:
  title: Sample API
  version: 1.0.0
paths:
  /users:
    get:
      summary: Get all users
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: integer
                    name:
                      type: string

Плюсы:

• Автоматическая документация.
• Валидация запросов/ответов.
• Интерактивное тестирование.

Используется с библиотеками типа drf-yasg (Django REST) или fastapi-swagger-ui (FastAPI).