apidoc.php 1.3 KB

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