2012-04-02 12 views
10

Mientras se trabaja en la documentación de una API REST bastante grande y buscando una buena presentación en particular, me encontré con la documentación API stripe.com: https://stripe.com/docs/apidocumentación con estilo de rocco para API -like stripe.com-?

inicialmente Empecé con la documentación de uso de la API en un archivo de texto simple, mientras que yo estoy haciendo el progreso en el proyecto. Pero ahora que tendré otros ingenieros trabajando conmigo y los usuarios interactuando con la API, me gustaría producir algo así como la documentación de stripe.com.

Me encontré con Rocco, y es bastante agradable! pero no tengo idea de cómo stripe peeps formateó la columna de la derecha para renderizar títulos en negrita, carga útil json y ...

¿Algún ejemplo?

Estoy muy consciente de que la documentación de la API es una pregunta bastante común, pero estoy preguntando acerca de cómo usar rocco a similar para representar más que solo el código en la columna de la derecha.

Thx!

Respuesta

1

No estoy seguro de cómo hacerlo con rocco, pero en caso de que pueda cambiar el constructor tiene api_docs gema que proporciona una buena salida formateada de arranque.

api_doc output example

Cuestiones relacionadas