Что такое Swagger и OpenAPI: полное руководство по документированию API

Введение

Вы создали отличный API. Он быстрый, надёжный, хорошо спроектированный. Но если у него нет документации — им никто не сможет пользоваться. Разработчики потратят часы на угадывание endpoint'ов, форматов запросов и типов ответов.

Swagger и OpenAPI решают эту проблему. Они позволяют описать ваш API в машиночитаемом формате, автоматически сгенерировать красивую документацию, клиентские SDK и даже серверные заглушки.

В этой статье вы узнаете:

• ✅ Что такое Swagger и OpenAPI (и в чём разница)
• ✅ Как написать OpenAPI-спецификацию с нуля
• ✅ Как настроить Swagger UI для вашего проекта
• ✅ Инструменты экосистемы Swagger
• ✅ Design-First vs Code-First подход
• ✅ Примеры интеграции на Node.js, Python и PHP

Что такое Swagger

Swagger — это набор инструментов для проектирования, документирования и тестирования REST API. Swagger был создан в 2011 году компанией SmartBear и быстро стал стандартом индустрии.

Swagger включает несколько инструментов:

• Swagger Editor — онлайн-редактор для написания спецификации
• Swagger UI — красивая интерактивная документация
• Swagger Codegen — генератор клиентского и серверного кода
• SwaggerHub — облачная платформа для совместной работы

Что такое OpenAPI

OpenAPI Specification (OAS) — это стандарт для описания REST API в машиночитаемом формате (YAML или JSON). Спецификация определяет структуру API: endpoint'ы, методы, параметры, тела запросов, ответы, схемы данных и авторизацию.

История: от Swagger к OpenAPI

Swagger vs OpenAPI — в чём разница

Экосистема инструментов

Основы OpenAPI-спецификации

OpenAPI-файл описывает ваш API в формате YAML или JSON. Разберём основные блоки:

Минимальная спецификация

openapi: 3.0.3
info:
  title: My API
  description: Описание моего API
  version: 1.0.0

servers:
  - url: https://api.example.com/v1
    description: Production сервер
  - url: http://localhost:3000/v1
    description: Локальная разработка

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
          example: 42
        name:
          type: string
          example: "Иван Петров"
        email:
          type: string
          format: email
          example: "ivan@example.com"

Структура файла

Полный пример спецификации

Полноценное описание CRUD API для пользователей:

openapi: 3.0.3
info:
  title: Users API
  description: API для управления пользователями
  version: 1.0.0
  contact:
    name: API Support
    email: support@example.com

servers:
  - url: https://api.example.com/v1

tags:
  - name: Users
    description: Операции с пользователями

security:
  - bearerAuth: []

paths:
  /users:
    get:
      tags: [Users]
      summary: Список пользователей
      description: Получить список всех пользователей с пагинацией
      parameters:
        - name: page
          in: query
          schema:
            type: integer
            default: 1
        - name: limit
          in: query
          schema:
            type: integer
            default: 20
            maximum: 100
        - name: role
          in: query
          description: Фильтр по роли
          schema:
            type: string
            enum: [admin, user, moderator]
      responses:
        '200':
          description: Список пользователей
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/User'
                  pagination:
                    $ref: '#/components/schemas/Pagination'
        '401':
          $ref: '#/components/responses/Unauthorized'

    post:
      tags: [Users]
      summary: Создать пользователя
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateUser'
      responses:
        '201':
          description: Пользователь создан
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
          headers:
            Location:
              schema:
                type: string
              description: URL созданного пользователя
        '400':
          $ref: '#/components/responses/BadRequest'
        '409':
          description: Email уже занят

  /users/{id}:
    get:
      tags: [Users]
      summary: Получить пользователя
      parameters:
        - $ref: '#/components/parameters/UserId'
      responses:
        '200':
          description: Данные пользователя
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
        '404':
          $ref: '#/components/responses/NotFound'

    patch:
      tags: [Users]
      summary: Обновить пользователя
      parameters:
        - $ref: '#/components/parameters/UserId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateUser'
      responses:
        '200':
          description: Обновлённый пользователь
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'

    delete:
      tags: [Users]
      summary: Удалить пользователя
      parameters:
        - $ref: '#/components/parameters/UserId'
      responses:
        '204':
          description: Пользователь удалён
        '404':
          $ref: '#/components/responses/NotFound'

components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

  parameters:
    UserId:
      name: id
      in: path
      required: true
      schema:
        type: integer

  schemas:
    User:
      type: object
      properties:
        id:
          type: integer
          example: 42
        name:
          type: string
          example: "Иван Петров"
        email:
          type: string
          format: email
          example: "ivan@example.com"
        role:
          type: string
          enum: [admin, user, moderator]
          example: "user"
        created_at:
          type: string
          format: date-time

    CreateUser:
      type: object
      required: [name, email]
      properties:
        name:
          type: string
          minLength: 2
          maxLength: 100
        email:
          type: string
          format: email
        role:
          type: string
          enum: [admin, user, moderator]
          default: user

    UpdateUser:
      type: object
      properties:
        name:
          type: string
        email:
          type: string
          format: email
        role:
          type: string
          enum: [admin, user, moderator]

    Pagination:
      type: object
      properties:
        page:
          type: integer
        limit:
          type: integer
        total:
          type: integer
        total_pages:
          type: integer

  responses:
    Unauthorized:
      description: Требуется авторизация
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
                example: "Token is missing or expired"

    BadRequest:
      description: Некорректный запрос

    NotFound:
      description: Ресурс не найден

Настройка Swagger UI

Swagger UI превращает YAML/JSON спецификацию в интерактивную документацию с возможностью тестирования API прямо из браузера.

Самый быстрый способ — Docker

# Запустить Swagger UI с вашей спецификацией
docker run -p 8080:8080 \
  -e SWAGGER_JSON=/spec/openapi.yaml \
  -v ./openapi.yaml:/spec/openapi.yaml \
  swaggerapi/swagger-ui

# Откройте http://localhost:8080

Встраивание в HTML-страницу

<!DOCTYPE html>
<html>
<head>
  <title>API Documentation</title>
  <link rel="stylesheet" href="https://unpkg.com/swagger-ui-dist/swagger-ui.css">
</head>
<body>
  <div id="swagger-ui"></div>

  <script src="https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js"></script>
  <script>
    SwaggerUIBundle({
      url: '/openapi.yaml',
      dom_id: '#swagger-ui',
      presets: [
        SwaggerUIBundle.presets.apis,
        SwaggerUIBundle.SwaggerUIStandalonePreset
      ],
      layout: 'StandaloneLayout'
    });
  </script>
</body>
</html>

Design-First vs Code-First

Два подхода к созданию OpenAPI-спецификации. Каждый имеет свои плюсы и минусы.

Интеграция: Node.js, Python, PHP

Node.js (Express + swagger-jsdoc)

const express = require('express');
const swaggerJsdoc = require('swagger-jsdoc');
const swaggerUi = require('swagger-ui-express');

const app = express();

const swaggerSpec = swaggerJsdoc({
  definition: {
    openapi: '3.0.3',
    info: {
      title: 'Users API',
      version: '1.0.0',
    },
    servers: [{ url: 'http://localhost:3000' }],
  },
  apis: ['./routes/*.js'],
});

app.use('/docs', swaggerUi.serve, swaggerUi.setup(swaggerSpec));

/**
 * @openapi
 * /api/users:
 *   get:
 *     summary: Список пользователей
 *     tags: [Users]
 *     responses:
 *       200:
 *         description: Список пользователей
 *         content:
 *           application/json:
 *             schema:
 *               type: array
 *               items:
 *                 type: object
 *                 properties:
 *                   id:
 *                     type: integer
 *                   name:
 *                     type: string
 */
app.get('/api/users', (req, res) => {
  res.json([
    { id: 1, name: 'Иван' },
    { id: 2, name: 'Мария' }
  ]);
});

app.listen(3000, () =>
  console.log('API: http://localhost:3000, Docs: http://localhost:3000/docs')
);

Python (FastAPI — встроенный Swagger)

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI(
    title="Users API",
    description="API для управления пользователями",
    version="1.0.0"
)

class User(BaseModel):
    id: int
    name: str
    email: str

class CreateUser(BaseModel):
    name: str
    email: str

users_db = [
    User(id=1, name="Иван", email="ivan@example.com"),
    User(id=2, name="Мария", email="maria@example.com"),
]

@app.get("/api/users", response_model=list[User], tags=["Users"])
async def get_users():
    """Получить список всех пользователей"""
    return users_db

@app.post("/api/users", response_model=User, status_code=201, tags=["Users"])
async def create_user(user: CreateUser):
    """Создать нового пользователя"""
    new_user = User(id=len(users_db) + 1, **user.dict())
    users_db.append(new_user)
    return new_user

# Swagger UI автоматически доступен: http://localhost:8000/docs
# ReDoc:                              http://localhost:8000/redoc

PHP (Laravel + L5-Swagger)

<?php

namespace App\Http\Controllers;

/**
 * @OA\Info(
 *     title="Users API",
 *     version="1.0.0",
 *     description="API для управления пользователями"
 * )
 * @OA\Server(url="https://api.example.com")
 */
class ApiController extends Controller {}

/**
 * @OA\Schema(
 *     schema="User",
 *     type="object",
 *     @OA\Property(property="id", type="integer", example=42),
 *     @OA\Property(property="name", type="string", example="Иван"),
 *     @OA\Property(property="email", type="string", format="email")
 * )
 */
class UserController extends Controller
{
    /**
     * @OA\Get(
     *     path="/api/users",
     *     summary="Список пользователей",
     *     tags={"Users"},
     *     @OA\Response(
     *         response=200,
     *         description="Список пользователей",
     *         @OA\JsonContent(
     *             type="array",
     *             @OA\Items(ref="#/components/schemas/User")
     *         )
     *     ),
     *     @OA\Response(response=401, description="Не авторизован")
     * )
     */
    public function index()
    {
        return response()->json(User::all());
    }

    /**
     * @OA\Post(
     *     path="/api/users",
     *     summary="Создать пользователя",
     *     tags={"Users"},
     *     @OA\RequestBody(
     *         required=true,
     *         @OA\JsonContent(
     *             required={"name", "email"},
     *             @OA\Property(property="name", type="string"),
     *             @OA\Property(property="email", type="string", format="email")
     *         )
     *     ),
     *     @OA\Response(response=201, description="Создан")
     * )
     */
    public function store(Request $request)
    {
        $user = User::create($request->validated());
        return response()->json($user, 201);
    }
}

# Установка L5-Swagger для Laravel
composer require darkaonline/l5-swagger
php artisan vendor:publish --provider="L5Swagger\L5SwaggerServiceProvider"
php artisan l5-swagger:generate

# Документация: http://your-app.com/api/documentation

Генерация кода

Одно из главных преимуществ OpenAPI — автоматическая генерация кода из спецификации. Это избавляет от рутины и гарантирует соответствие клиента и сервера.

OpenAPI Generator

# Установить OpenAPI Generator
npm install @openapitools/openapi-generator-cli -g

# Сгенерировать TypeScript-клиент
openapi-generator-cli generate \
  -i openapi.yaml \
  -g typescript-fetch \
  -o ./generated/client

# Сгенерировать серверный код на Express
openapi-generator-cli generate \
  -i openapi.yaml \
  -g nodejs-express-server \
  -o ./generated/server

# Сгенерировать Python-клиент
openapi-generator-cli generate \
  -i openapi.yaml \
  -g python \
  -o ./generated/python-client

Что можно сгенерировать

Best Practices

Линтинг спецификации (Spectral)

# Установить Spectral
npm install -g @stoplight/spectral-cli

# Проверить спецификацию
spectral lint openapi.yaml

# Пример вывода:
# openapi.yaml
#   12:5  warning  operation-description  Operation should have a description.
#   25:9  error    oas3-valid-schema      Schema must have a type.

FAQ

# Пример: TypeScript-клиент
openapi-generator-cli generate -i api.yaml -g typescript-fetch -o ./client

Заключение

Swagger и OpenAPI — это не просто «документация для галочки». Это полноценный инструмент проектирования, который ускоряет разработку, улучшает коммуникацию в команде и делает ваш API понятным для любого разработчика.

Статья опубликована: 23 февраля 2026
Автор: LightBox API Team