Документ приватного веб API

Question

Мы настроили веб-API для внутреннего использования в проекте. Я ищу хороший способ документировать наш API. Я искал в Интернете и нашел

• IO Docs
• развязность

Эти инструменты читают в файлах JSON, которые могут быть созданы автоматически, например, для Java. Наш API вырос, и мне нравится создавать JSON вручную, а не вручную в текстовом редакторе. Есть ли инструмент или интерфейс, который облегчает бремя создания описательного JSON вручную?

С другой стороны, каковы рекомендуемые инструменты для документации веб-API?

Answer 1

Я работаю в.NET (C#) магазине, и мы используем чванство для документирования нашего API. Мы не смогли найти никаких инструментов, чтобы выполнить то, что вы просите... поэтому мы просто создали свои собственные. Я не думаю, что Swagger достаточно зрелый, чтобы порождать подобные проекты... пока.

Нетрудно было создать классы для представления объектов json, описанных в документации Swagger. Мы просто берем эти экземпляры классов и запускаем их через сериализатор JSON, чтобы получить наши отдельные файлы json, описывающие наши конечные точки.

Удачи!