Да, создание спецификации API с помощью Swagger (теперь известного как OpenAPI) — распространённая практика для документирования RESTful сервисов.

Swagger позволяет описать структуру API — эндпоинты, методы, параметры, модели данных — в формате YAML или JSON. Это облегчает понимание API для разработчиков и автоматизирует генерацию документации и клиентских SDK.

Пример минимальной спецификации Swagger в формате YAML:

openapi: 3.0.0
info:
  title: Sample API
  version: 1.0.0
paths:
  /users:
    get:
      summary: Получить список пользователей
      responses:
        '200':
          description: Успешный ответ
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: integer
                    name:
                      type: string

В Python для работы со Swagger часто используют библиотеки, например, Flask-RESTPlus, FastAPI (встроенная поддержка OpenAPI) или Connexion, которые помогают автоматически генерировать спецификацию из кода.

Бывали ли случаи, когда вы создавали спецификацию API с использованием Swagger?