apidoc.php 1.3 KB

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