configuration.yaml 2.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  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. LoginBackground:
  26. get:
  27. operationId: getLoginBackground
  28. summary: 查询登录界面自定义背景图
  29. description: >-
  30. 返回服务端运行目录下的 background.jpg 或 background.png(jpg优先);
  31. 携带 theme 查询参数(blue/red/green)时优先返回 background-{theme}.jpg/png,
  32. 主题背景图不存在时回落通用 background.jpg/png(契约1.31);
  33. 运行目录不存在背景图文件时返回404,前端回退默认纯色背景。
  34. 接口公开(登录前无凭证可访问),允许浏览器缓存60秒。
  35. security: []
  36. parameters:
  37. - $ref: '../components/parameters.yaml#/XRequestId'
  38. - name: theme
  39. in: query
  40. required: false
  41. description: 主题键(契约1.31);白名单外的取值按未提供处理,回落通用背景图。
  42. schema:
  43. type: string
  44. enum: [blue, red, green]
  45. responses:
  46. '200':
  47. description: 背景图片二进制
  48. headers:
  49. X-Request-Id:
  50. description: 与请求发送的X-Request-Id一致
  51. schema:
  52. type: string
  53. format: uuid
  54. content:
  55. image/jpeg:
  56. schema:
  57. type: string
  58. format: binary
  59. image/png:
  60. schema:
  61. type: string
  62. format: binary
  63. '404':
  64. description: 运行目录下不存在背景图文件
  65. content:
  66. application/json:
  67. schema:
  68. $ref: '../components/schemas.yaml#/ErrorResponse'
  69. '500':
  70. $ref: '../components/responses.yaml#/InternalError'