2012-10-12 9 views
14

Estoy tratando de usar la herramienta autodoc para generar API doc para la API REST sabroso. Probé sabroso, pero parece que no muestra los parámetros de resultados de la API, pero las columnas del modelo. Luego probé Sphinx parece más prometedor ya que Tastypie admite Sphinx, pero no puedo encontrar un ejemplo para mostrar dónde & cómo poner comentarios para la API dentro del código, y generarlos en el documento.Generación de documentación de Tastypie

¿Alguien puede compartir alguna información o ejemplo sobre cómo escribir comentarios correctamente y generar Sphinx doc para API basada en Tastypie? Gracias.

Respuesta

13

Es posible que desee echar un vistazo a tastypie-swagger, que utiliza Swagger para generar una/doc/página para su Tastypie API.

He tenido cierto éxito con ella, después de algunas adaptaciones menores (que eran necesarias debido a una diferencia de versión sabrosa, supongo).

Editar: Las adaptaciones que encontré necesario (debido a una versión Django < 1.4 y la versión tastypie> 0.9.11), se han unido en la rama de la línea principal de tastypie-contoneo.

+0

tastypie-swagger no es compatible con la última versión de django. Alguna idea sobre superar ese obstáculo? Gracias –

0

Tal vez me falta por completo el punto de su pregunta, pero si usted está tratando de generar los documentos que vienen con la distribución de la fuente hay un Makefile en el directorio docs que lleva a cabo las acciones necesarias. Se requiere que especifique un tipo de salida de destino como html, json, latex, etc. Guardo una copia local de los documentos para django, tastypie y soñoliento cuando utilizo los tres conjuntamente y utilizo la opción make html frecuentemente.

Si me equivoco acerca de lo que está tratando de lograr quizás podamos obtener alguna aclaración.

+0

Lo siento por no haber aclarado mi pregunta. Puedo generar el documento con Sphinx, la línea de comando incorporada, pero no puedo encontrar el lugar y formato correctos para poner mi comentario para cada API en mi código y generarlos en el documento. –

+0

¿Está intentando escribir la documentación de sphinx para sus propias clases de API que utilizan Tastypie? – zzzirk

Cuestiones relacionadas