apidoc.php 1.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  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\\Expedite',
  16. // 'api\\controller\\General',
  17. // 'api\\controller\\Crystal',
  18. // 'api\\controller\\GoodsOrder',
  19. // 'api\\controller\\Timedtask',
  20. ],
  21. // 指定公共注释定义的文件地址
  22. 'definitions'=>"app\controller\Definitions",
  23. // 设置可选版本
  24. 'versions'=>[
  25. ['title'=>'V1.0','folder'=>'']
  26. ],
  27. // 控制器分组列表
  28. 'groups'=>[
  29. ],
  30. // 是否开启缓存
  31. 'with_cache'=>false,
  32. // 统一的请求响应体
  33. 'responses'=>'{
  34. "code":"状态码",
  35. "message":"操作描述",
  36. "data":"业务数据",
  37. "timestamp":"响应时间戳"
  38. }',
  39. // 设置全局Authorize时请求头headers携带的key
  40. 'global_auth_key'=>"Authorization",
  41. // 密码验证配置
  42. 'auth'=>[
  43. // 是否启用密码验证
  44. 'with_auth'=>false,
  45. // 验证密码
  46. 'auth_password'=>"123456",
  47. // 验证请求头中apidocToken的字段,默认即可
  48. 'headers_key'=>"apidocToken",
  49. ],
  50. // 过滤、不解析的方法名称
  51. 'filter_method'=>[
  52. '_empty',
  53. '_initialize',
  54. '__construct',
  55. '__destruct',
  56. '__get',
  57. '__set',
  58. '__isset',
  59. '__unset',
  60. '__cal',
  61. ],
  62. ];