apidoc.php 1.3 KB

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