стильная документация по rocco для API-подобного stripe.com-? - PullRequest
10 голосов
/ 02 апреля 2012

Работая над документированием довольно большого API-интерфейса REST и в особенности в поисках хорошей презентации, я натолкнулся на документацию по API stripe.com: https://stripe.com/docs/api

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

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

Какие-нибудь примеры?

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

Thx!

1 Ответ

1 голос
/ 17 октября 2013

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

api_doc output example

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...