phpDocumentor似乎是记录PHP代码的标准,虽然我不知道为什么它多年没有更新..?
但是,它似乎不适合记录REST API的入口点; IE,系统最终用户可能感兴趣的外部可访问入口点,而不是记录所有内部类等 - 这只是api开发人员感兴趣的内容.
我正在寻找我可以说的东西,嘿这个方法可以通过REST在这个URL外部访问,这里是GET或POST参数,它支持GET/POST/etc HTTP方法,它返回JSON或XML等等.
该信息将能够生成API文档.内部代码也可以使用它来自动过滤输入,验证输出,创建基本单元测试等.
如果我有一个基于REST的服务,用Symfony [symfony-project.org]框架(即PHP)编写,那么是否有任何不错的工具/框架可以解析我的代码并生成API文档?
基于Java的框架包含类似于我需要的文档功能,您可以在此处查看此示例:http://enunciate.codehaus.org/wannabecool/step1/index.html.
我理解基于REST的服务的前提应该是不言而喻的,但是我想要为我生成这个文档的东西,而不需要手动写出我的所有端点,支持的格式,样本输出等.
谢谢