背景 我们的restful api项目采用yaf框架, 整体结构简单, 我们只需要用swagger扫描 application目录即可。 下面简称我们的php项目为yaf_project. 搭建 先说下最终的文档生成流程会是什么样子,以便先有个整体的认识: 搭建完成后, 整个流程, 从文档生成到前端展现, 大体如下: 在php文件中写 swagger 格式的 /** 注释 */ 用 swagger-php 内的 bin/swagger.phar 命令扫描 项目application 所在目录, 生成 swagger.json 文件 将 swagger.json 文件拷贝到swagger-ui中index.html指定的目录。 打开 swagger-ui 所在的 url, 就可以看到文档了. 文档中的各个 api 可以在该网址上直接访问得到数据. 实现此需求,只需要swagger如下的两个项目: swagger-php: 扫描 php 注释的工具. 内含一个不错的例子. swagger-ui: 用以将扫描工具生成的 swagger.json 文件内容展示在网页上. git clone https://github.com/zircote/swagger-php.git git clone https://github.com/swagger-api/swagger-ui.git 或者: npm install swagger-ui-dist 文档生成工具(swagger)部署 NOTE: swagger-php 只是个工具,放在哪里都可以. 主要工作,解决composer依赖。 因为国内直接用 composer 比较蛋疼,所以最好设置下国内的那个 composer 源. 文档工具部署,需要以下三个命令: cd swagger - php composer config repo . packagist composer https : // packagist.phpcomposer.com composer update 只要中间不报错,就算部署完成了. 完成后可以生成一份文档试一下. swagger-php 项目下的 Examples 目录下有一个示例php工程,里面已经用 swagger 格...
评论