使用ThinkPHP生成API文档的方法如下:
1.安装 topthink/think-api-doc
扩展:可以通过在命令行运行 composer require topthink/think-api-doc
来安装,也可以手动修改 composer.json
文件,并通过运行composer update
进行安装。
/**
开始,在 每个接口函数 的开头添加注释.基本注释格式如下
/**
* 接口名称
* @param string $param1 参数说明 例如:手机号码
* @return json 状态码和对应信息提示
*/
public function functionName($param1){}
3.执行文档生成命令:在项目根目录下打开终端,运行命令 php think api_doc --output ./public/apidoc
将会在 ./public/apidoc
目录下自动生成 API 文档的 HTML 静态文件。
需要注意的是,在使用 think-api-doc
时,所有接口都必须采用 RESTful
风格,并且由于 API 是通过 HTTP 请求调用的,因此支持所有客户端(Web、Android、iOS 等)直接访问。
关键词高亮: