Я ищу эффективный способ создания документации API в удобочитаемом формате из сгенерированных файлов из Cloud Endpoint (Java). Сгенерированные файлы: - my_api.api - my_api*.discovery
Что-то вроде этого: - https://github.com/kevinrenskers/raml2html#example-output< /а>
Swagger, схема API и RAML — все это хорошие варианты, но, похоже, они плохо адаптируются к файлам дескрипторов API, сгенерированным конечными точками.
Какие методы вы используете?
К сожалению, мы (Apiary) на данный момент не предлагаем никаких инструментов для генерации кода для API Blueprint.
Если вы ищете способ, как сгенерировать описание вашего API из кода, то API Blueprint, вероятно, не лучший выбор, поскольку мы считаем, что он должен представлять собой контракт между всеми, кто участвует в жизненном цикле разработки API. Это также причина, по которой мы создали инструмент тестирования — Dredd — https://github.com/apiaryio/dredd< /а>
С Dredd вы можете проверить, соответствует ли ваша реализация API вашему плану. Не было бы особого смысла, если бы план был сгенерирован из реализации.
Надеюсь, это проясняет.
