Thinkphp中用Apidoc生成接口文档
一.Apidoc
apidoc能做什么 apidoc是一个轻量级的在线REST接口文档生成系统,可以根据其特定的规则的代码注释来生成静态网页。
二.Apidoc使用
1.安装node.js
Node.js 是一个基于 Chrome V8 引擎的 JavaScript 运行时。 Node.js 使用高效、轻量级的事件驱动、非阻塞 I/O 模型。Node.js 的生态系统是目前最大的开源包管理系统。下载地址: https:// nodejs.org/zh-cn/
2.安装Apidoc
npm install apidoc -g
3.配置
在你的项目根目录或应用目录下新建 apidoc.json文件,该文件描述了项目对外提供接口的概要信息如名称、版本、描述、文档打开时浏览器显示标题和接口缺省访问地址。
apidoc.json
{
"name": "example",
"version": "0.1.0",
"description": "apiDoc basic example",
"title": "Custom apiDoc browser title",
"url" : "https://api.github.com/v1"
}
json配置
更详细的说明请参考官方文档http://apidocjs.com
4.使用
公共部分定义
Thinkphp可以在继承的公共控制器文件Base.php文件中定义
Base.php
// ==========================================================================================
// 公共部分定义-响应字段说明
// ==================