Как технически реализовать OpenAPI спецификацию? Что такое Swagger?

OpenAPI спецификация — это стандарт для описания REST API в формате JSON или YAML. Технически её реализация включает в себя:

• Создание файла спецификации (например, openapi.yaml), где описываются пути, методы, параметры, модели данных и ответы API.
• Использование инструментов для генерации документации, серверного кода или клиентов на основе этой спецификации.

Swagger — это набор инструментов для работы с OpenAPI спецификацией. Он включает:

• Swagger Editor — онлайн или локальный редактор для создания и редактирования спецификаций.
• Swagger UI — визуальный интерфейс для интерактивной документации API.
• Swagger Codegen — генератор кода на разных языках по спецификации.

Пример простого OpenAPI описания:

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: string

В Go можно использовать такие библиотеки, как swaggo/swag для генерации документации из комментариев в коде.