Dom*_*nic 3 php rest symfony1 enunciate documentation-generation
如果我有一个基于REST的服务,用Symfony [symfony-project.org]框架(即PHP)编写,那么是否有任何不错的工具/框架可以解析我的代码并生成API文档？
基于Java的框架包含类似于我需要的文档功能,您可以在此处查看此示例:http://enunciate.codehaus.org/wannabecool/step1/index.html.
我理解基于REST的服务的前提应该是不言而喻的,但是我想要为我生成这个文档的东西,而不需要手动写出我的所有端点,支持的格式,样本输出等.
谢谢
不确定你以前是否见过Swagger.他们似乎有一个PHP兼容的版本,虽然我不能亲自担保它.它做了一些自动的API文档生成,与enunciate相当,虽然看起来它需要一些重要的手动文档,通过PHP注释.话虽如此,我认为手动工作将与制作自己的wiki页面相同或更少,并且输出更好,更好.
正如仿真陈述,它看起来像字正腔圆具有无限计划最终支持其他平台,但有关吉拉票是目前打开等待赞助商来承担这项工作.
支持其他语言的第一步是将Enunciate模型与Java模型分离.这项工作正在ENUNCIATE-584进行跟踪和记录.不幸的是,它从未进入调查阶段,因为它有多重.除非找到工作的赞助商,否则我预计不会很快承担这么重的负担.
编辑:
发现一个类似的问题,其中有人提到了一个专门用于Swagger + Symfony2的GitHub项目.这个问题是相同的,但没有其他信息.
| 归档时间： |
|
| 查看次数： |
1890 次 |
| 最近记录： |