apidoc.php 1.5 KB

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