configuration.yaml 2.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
  1. UiDictionaries:
  2. get:
  3. operationId: getUiDictionaries
  4. summary: 查询统一UI展示字典
  5. description: 返回启动时加载的只读展示标签;不提供配置路径或写操作。
  6. parameters:
  7. - $ref: '../components/parameters.yaml#/XRequestId'
  8. responses:
  9. '200':
  10. description: 完整UI展示字典
  11. headers:
  12. X-Request-Id:
  13. description: 与响应体requestId相同
  14. schema:
  15. type: string
  16. format: uuid
  17. content:
  18. application/json:
  19. schema:
  20. $ref: '../components/schemas.yaml#/UiDictionariesResponse'
  21. '401':
  22. $ref: '../components/responses.yaml#/AuthenticationError'
  23. '500':
  24. $ref: '../components/responses.yaml#/InternalError'
  25. RuntimeConfig:
  26. get:
  27. operationId: getRuntimeConfig
  28. summary: 查询运行时只读配置
  29. description: 暴露后端.env决定的非敏感开关(如PDF预览引擎);允许浏览器缓存60秒。
  30. security: []
  31. parameters:
  32. - $ref: '../components/parameters.yaml#/XRequestId'
  33. responses:
  34. '200':
  35. description: 运行时配置
  36. content:
  37. application/json:
  38. schema:
  39. $ref: '../components/schemas.yaml#/RuntimeConfigResponse'
  40. '500':
  41. $ref: '../components/responses.yaml#/InternalError'
  42. LoginBackground:
  43. get:
  44. operationId: getLoginBackground
  45. summary: 查询登录界面自定义背景图
  46. description: >-
  47. 返回服务端运行目录下的 background.jpg 或 background.png(jpg优先);
  48. 运行目录不存在背景图文件时返回404,前端回退默认纯色背景。
  49. 接口公开(登录前无凭证可访问),允许浏览器缓存60秒。
  50. security: []
  51. parameters:
  52. - $ref: '../components/parameters.yaml#/XRequestId'
  53. responses:
  54. '200':
  55. description: 背景图片二进制
  56. headers:
  57. X-Request-Id:
  58. description: 与请求发送的X-Request-Id一致
  59. schema:
  60. type: string
  61. format: uuid
  62. content:
  63. image/jpeg:
  64. schema:
  65. type: string
  66. format: binary
  67. image/png:
  68. schema:
  69. type: string
  70. format: binary
  71. '404':
  72. description: 运行目录下不存在背景图文件
  73. content:
  74. application/json:
  75. schema:
  76. $ref: '../components/schemas.yaml#/ErrorResponse'
  77. '500':
  78. $ref: '../components/responses.yaml#/InternalError'