Подтвердить что ты не робот

Стильная документация rocco для API-подобных stripe.com-?

Во время работы над документированием довольно большой REST api и, прежде всего, поиска хорошей презентации, я столкнулся с документацией strip.com api: https://stripe.com/docs/api

Сначала я начал с документирования использования API в простом текстовом файле, пока я делаю прогресс в проекте. Но теперь, когда у меня будут работать другие инженеры, работающие со мной и пользователями, взаимодействующими с API, я бы хотел создать нечто вроде полосы .com.

Я наткнулся на роко, и это очень приятно! но я понятия не имею, как stripe peeps форматирует правый столбец для визуализации смелых названий, полезной нагрузки json и....

Любые примеры?

Я довольно хорошо знаю, что документация по API - довольно распространенные вопросы, но я спрашиваю, как использовать rocco для аналогичного, чтобы сделать больше, чем просто код в правой колонке.

спасибо!

4b9b3361

Ответ 1

Не уверен, как это сделать с помощью rocco, но в случае, если вы можете изменить конструктор, у вас есть api_docs gem, который обеспечивает приятное бутстрап отформатированный выход.

api_doc output example