在Swagger UI中美化Json响应

Swagger UI 是一个用于设计、构建、记录和使用 RESTful Web 服务的强大框架。它允许开发者直接在浏览器中查看和测试 API，并且可以自定义显示的样式和布局。美化 JSON 响应可以让开发者更直观地理解 API 返回的数据结构。

基础概念

Swagger UI 是 Swagger（现称为 OpenAPI）规范的一个可视化工具，它能够根据 API 文档自动生成交互式的 API 文档页面。

JSON 美化 是指将紧凑的 JSON 数据格式化为更易读的形式，通常包括缩进、换行和适当的空格。

类型与应用场景

类型：JSON 美化通常是自动进行的，根据一定的规则（如缩进大小、缩进字符等）对 JSON 数据进行格式化。
应用场景：在开发过程中，当开发者需要查看 API 返回的详细数据时，美化后的 JSON 可以提供很大的帮助。

遇到的问题及解决方法

问题：Swagger UI 中的 JSON 响应没有自动美化。

原因：可能是由于 Swagger UI 的配置问题，或者是浏览器插件/扩展干扰了正常的显示。

解决方法：

检查 Swagger 配置：确保你的 OpenAPI 规范文件（通常是 swagger.json 或 openapi.yaml）中没有禁用 JSON 美化的选项。
使用浏览器的开发者工具：在某些情况下，浏览器的开发者工具可能会提供 JSON 格式化的功能。你可以尝试在控制台中查看响应，并使用其格式化功能。
禁用干扰插件：如果你怀疑是浏览器插件导致的问题，可以尝试在无痕模式下打开 Swagger UI 或者禁用所有插件后再次尝试。
自定义样式：如果上述方法都不奏效，你可以尝试通过自定义 CSS 来美化 Swagger UI 中的 JSON 显示。例如，你可以增加缩进和换行来改善可读性。

示例代码

假设你有一个 OpenAPI 规范文件 openapi.yaml，你可以这样配置以确保 JSON 响应是自动美化的：

openapi: 3.0.0
info:
  title: Sample API
  version: 1.0.0
paths:
  /example:
    get:
      summary: Get example data
      responses:
        '200':
          description: A successful response
          content:
            application/json:
              schema:
                type: object

在 Swagger UI 中，通常不需要额外的配置就可以自动美化 JSON 响应。如果需要手动美化，可以使用在线 JSON 美化工具，如 JSONLint 或 JSON Formatter & Validator。