Как предоставить документацию API в Anypoint Studio

#anypoint-studio #raml

#anypoint-studio #raml

Вопрос:

Я настроил RAML API в Anypoint studio, и макет работает. Как я могу предоставить документацию, которую я вижу в консоли, на веб-странице, чтобы другие люди могли ее видеть?

Спасибо

Ответ №1:

Когда вы разрабатываете спецификации RAML для своего API и развертываете спецификацию как часть приложения Mule, вы увидите часть документации в консоли.
Чтобы сделать ее независимой, вы можете опубликовать ее как часть PDF или HTML.
Для этого вы можете использовать RAML2HTML или ramlo.
Вы также можете использовать raml2md для вывода файла Markdown. Оттуда вы можете легко сгенерировать PDF-файл с помощью pandoc для экспорта документации в формате PDF.
ссылка: — http://forums.raml.org/t/exporting-raml-documentation/1043

Вы также можете обратиться к своей проблеме: — http://forums.raml.org/t/generating-documentation-from-raml-spec/165/3