Comment documenter une API REST basée sur Symfony (similaire aux capacités de documentation d'Enunciate)

Question

Si j'ai un service basé sur REST écrit dans le framework Symfony [symfony-project.org] (ie PHP), y a-t-il des outils/frameworks décents? là qui va analyser mon code et générer de la documentation API? Le framework basé sur Java dispose de fonctionnalités de documentation similaires à ce dont j'ai besoin, vous pouvez en voir un exemple ici: http://enunciate.codehaus.org/wannabecool/step1/index.html. Je comprends que la prémisse des services basés sur REST est supposée être évidente, mais je recherchais quelque chose qui génèrerait cette documentation pour moi sans avoir à écrire manuellement tous mes terminaux, formats pris en charge, sortie d'exemple, etc.

Merci

Answer 1

À ma connaissance, il n'y a aucun moyen d'automatiser la documentation des types de médias.

Si vous utilisez un type de média tel que XHTML, un robot d'indexation Web tel que Google sitemap peut produire des résultats utiles pour montrer les relations entre vos ressources.

Answer 2

Vous ne savez pas si vous avez déjà vu Swagger auparavant. Ils semblent avoir un PHP compatible version, même si je ne peux pas vraiment se porter garant personnellement. Il produit une génération automatique de documentation d'API comparable à celle d'enunciate, bien qu'il semble que cela nécessite une importante documentation manuelle via les commentaires PHP. Cela étant dit, je pense que l'effort manuel sera le même ou moins que de faire votre propre via les pages wiki, et la sortie est beaucoup, beaucoup plus agréable.

Tout comme un factoid, il ressemble à Enunciate has indefinite plans to eventually support other platforms, mais le relevant Jira ticket est actuellement ouvert en attente d'un parrain de prendre le travail.

De l'ENUNCIATE-356 Jira ticket:

La première étape à soutenir d'autres langues est de découpler le modèle Enunciate du modèle Java. Ce travail est suivi et enregistré au ENUNCIATE-584. Malheureusement, il n'a jamais été éliminé de la phase d'enquête en raison de sa lourdeur. À moins de trouver un commanditaire pour le travail, je ne prévois pas de prendre cette lourde charge de sitôt.

Edit:
Trouvé un similar question où someone mentions un GitHub project dedicated to Swagger+Symfony2. This other question est le même, mais aucune information supplémentaire.