3

Symfony [symfony-project.org] フレームワーク (つまり PHP) で記述された REST ベースのサービスがある場合、コードを解析して API ドキュメントを生成する適切なツール/フレームワークはありますか?

Java ベースのフレームワーク enunciate には、私が必要としているものと同様のドキュメント機能があります。この例は、http: //enunciate.codehaus.org/wannabecool/step1/index.htmlで確認できます。

I understand the premise of REST based services are supposed to be self evident, however I was after something that would generate this documentation for me without the need to manually write up all my endpoints, supported formats, sample output etc.

Thanks

4

2 に答える 2

6

以前にSwaggerを見たことがあるかどうかはわかりません。彼らはPHP互換バージョンを持っているようですが、私はそれを個人的に保証することはできません。これは、enunciateに匹敵する自動APIドキュメント生成を実行しますが、PHPコメントを介した大量の手動ドキュメントが必要なように見えます。そうは言っても、手作業はwikiページを介して自分で作成するのと同じかそれ以下であり、出力ははるかに優れていると思います。

事実と同じように、Enunciateは最終的に他のプラットフォームをサポートする予定が無期限にあるようですが、関連するJiraチケットは現在オープンであり、スポンサーが作業を引き受けるのを待っています。

ENUNCIATE-356 Jiraチケットから：

他の言語をサポートするための最初のステップは、EnunciateモデルをJavaモデルから切り離すことです。この作業は、ENUNCIATE-584で追跡および記録されています。残念ながら、それは非常に重いため、調査段階から抜け出すことはありませんでした。作品のスポンサーが見つからない限り、私はすぐにそのような重い負荷をかけることはないと思います。


編集： 誰かがSwagger+Symfony2専用のGitHubプロジェクトに言及している同様の質問
を 見つけました。この他の質問も同じですが、追加情報はありません。

于 2012-09-26T20:11:28.597 に答える
0

私の知る限り、メディア タイプのドキュメント化を自動化する方法はありません。

XHTML のようなメディア タイプを使用している場合、Google サイトマップのような Web クローラー は、リソース間の関係を示す有用な出力を生成することがあります。

于 2010-05-03T12:32:21.297 に答える