apidoc.php 1.5 KB

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