注意:文档已迁移至以下地址,本文将不再维护

GitHub地址:https://github.com/HGthecode/thinkphp-apidoc 文档地址:https://hgthecode.github.io/thinkphp-apidoc/ 示例地址:https://apidoc.demo.hg-code.com/apidoc/

由于API接口文档根据解析控制器中的注释生成,需按照一定的书写规则来生成。

控制器注释

1、接口文档将按照在配置文件/config/apidoc.php中配置的 controllers 控制器列表,来生成,若您希望 某个控制器被解析,那么首先在配置项中加入该控制器,如下:
app\controller\ApiTest.php

  1. 'controllers' => [
  2. 'controller\\ApiTest',
  3. ],

2、为控制器加上一些注释,以让文档可读性更高(当然这不是必须的)

  1. <?php
  2. namespace app\controller;
  3. /**
  4. * @title Api接口文档测试
  5. * @desc 测试一些注释的解析能力
  6. */
  7. class ApiTest
  8. {
  9. ...
  10. }

此时更新文档页面,得到一个控制器被解析
image.png