Edit me

Спецификация OpenAPI и Swagger

Спецификация OpenAPI предоставляет один из способов описания REST API и включает все разделы, упомянутые в предыдущем разделе Документирование конечных точек API. Фреймворки, такие как Swagger UI, могут анализировать спецификацию OpenAPI и генерировать интерактивную документацию, которая позволяет пользователям опробовать точки доступа при изучении API.

Содержание модуля “Спецификация OpenAPI и Swagger”

Обзор форматов спецификаций REST API

Знакомство со спецификациями OpenAPI и Swagger

Работа в YAML

Обзор руководства OpenAPI

Шаг 1: Объект openapi

Шаг 2: Объект info

Шаг3: Объект servers

Шаг 4: Объект paths

Шаг 5: Объект components

Шаг 6: Объект security

Шаг 7: Объект tags

Шаг 8: Объект externalDocs

Практическое занятие: Создание спецификации OpenAPI

Руководство Swagger UI

Демо Swagger UI

Введение и руководство SwaggerHub

Stoplight - инструмент визуального моделирования для создания спецификаций

Интеграция Swagger с документацией

🔙

Go next ➡