apidoc.php 1.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  1. <?php
  2. return [
  3. // 文档标题
  4. 'title'=>'APi接口文档',
  5. // 版权申明
  6. 'copyright'=>'Powered By HG',
  7. //生成文档的控制器
  8. 'controllers' => [
  9. 'api\\controller\\Login',
  10. 'api\\controller\\Index',
  11. 'api\\controller\\User',
  12. 'api\\controller\\Publics',
  13. ],
  14. // 指定公共注释定义的文件地址
  15. 'definitions'=>"app\controller\Definitions",
  16. // 设置可选版本
  17. 'versions'=>[
  18. ['title'=>'V1.0','folder'=>'']
  19. ],
  20. // 控制器分组列表
  21. 'groups'=>[
  22. ],
  23. // 是否开启缓存
  24. 'with_cache'=>false,
  25. // 统一的请求响应体
  26. 'responses'=>'{
  27. "code":"状态码",
  28. "message":"操作描述",
  29. "data":"业务数据",
  30. "timestamp":"响应时间戳"
  31. }',
  32. // 设置全局Authorize时请求头headers携带的key
  33. 'global_auth_key'=>"Authorization",
  34. // 密码验证配置
  35. 'auth'=>[
  36. // 是否启用密码验证
  37. 'with_auth'=>false,
  38. // 验证密码
  39. 'auth_password'=>"123456",
  40. // 验证请求头中apidocToken的字段,默认即可
  41. 'headers_key'=>"apidocToken",
  42. ],
  43. // 过滤、不解析的方法名称
  44. 'filter_method'=>[
  45. '_empty',
  46. '_initialize',
  47. '__construct',
  48. '__destruct',
  49. '__get',
  50. '__set',
  51. '__isset',
  52. '__unset',
  53. '__cal',
  54. ],
  55. ];