OpenAPI - первый интерфейс API

Question

Я пытаюсь задокументировать ссылку на API REST, используя формат OpenAPI (v2). Я хочу, чтобы это было "первым делом", а это означает, что моей спецификацией будет контракт на реализацию API.

Я перепробовал множество модулей и решений, например, swagger-node (слишком отзывчивый по поводу структуры и реализации папок), swaggerize-express, который заставляет меня использовать express, и т. Д. Я также попробовал генератор-openapi-repo, но он кажется устаревшим и больше не поддерживается,

Есть ли какое-либо решение для документирования ссылки на API REST, сначала разработанное и не связывающее документацию с фактической реализацией?

Answer 1

Вы можете использовать swagger-node просто как локальный редактор. С помощью этих команд запустите редактор swagger и напишите свою спецификацию swagger:

npm install -g swagger

swagger project create my-app

swagger project edit

После завершения дизайна, swagger.yaml файл, который хранится в api/swagger/, может быть использован для любой реализации.

Если вы ищете онлайн-редактор, проверка этих инструментов может быть полезна.

• Простой редактор: https://editor.swagger.io/
• Совместный редактор (предлагает бесплатную и платную версию): https://swaggerhub.com/