2012-01-15 26 views
5

¿Existe una manera fácil de generar documentos para REST api directamente desde un proyecto de Symfony?Auto generar REST API docs de Symfony

+0

¿Qué versión de Symfony estás usando? – MrGlass

+0

Estamos usando Symfony 2 –

+0

No creo que haya una manera de hacerlo automáticamente. La mayoría de las cosas deberían definirse en el enrutamiento, pero eso no funcionaría para la Documentación. – MrGlass

Respuesta

9

Lo siento por la publicación de publicaciones, pero hay un paquete de Symfony para ayudar a la generación de documentos API, puede consultar NelmioApiDocBundle que se conecta bien con FOSRestBundle.

La documentación de FOSRestBundle proporciona paquetes de muestra utilizando ambos paquetes para generar servicios web REST-ful y su documentación.

+0

¿Hay alguna manera de documentar los tipos de parámetros? en Nelmio (es decir, datos de formulario vs raw json, etc.)? vea [aquí] (https://github.com/nelmio/NelmioApiDocBundle/issues/403) – abbood

+0

Diría que tiene que usar la descripción para este caso de uso específico. Puede formatearlo en el marcado. –

+0

¿Hay alguna manera de generar las anotaciones también? – dustfeather