apidoc.php 1.5 KB

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