README

你可能处于错误的项目。主要项目是 swagger-api/swagger-ui。在这个分支中，我将 sampleFromSchema 修改为跳过从模型生成的样本中的引用，例如

"components": {
  "schemas": {
    "Group": {
      "description": "Group of users",
      "properties": {
        "group_id": {
          "type": "string",
          "description": "unique identifier of the group"
        },
        "name": {
          "type": "string",
          "description": "the name of the group"
        },
        "users": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/User"
          }        
        }
      }
    },
    "User": {
      "description": "A user",
      "properties": {
        "user_id": {
          "type": "string",
          "description": "unique identifier of the user"
        },
        "name": {
          "type": "string",
          "description": "the name of the user"
        },
        "group": {
          "$ref": "#/components/schemas/Group"
        }
      }
    }
  }
}

将在响应或分组请求体部分生成以下示例

{
  "group_id": "string",
  "name": "string",
}

对于用户

{
  "user_id": "string",
  "name": "string",
}

这对于处理非常复杂的领域非常有用

👉🏼 想要获得一个简单的开源贡献机会？ 请查看我们的 Good first issue 标签。

🕰️ 在寻找旧版本的 Swagger UI？ 请参考 2.x 分支。

此存储库发布到两个不同的 NPM 模块

• swagger-ui 是一个传统的 npm 模块，旨在用于能够解决依赖的单页应用程序（通过 Webpack、Browserify 等）。
• swagger-ui-dist 是一个无依赖的模块，包括在服务器端项目或无法解决 npm 模块依赖的单页应用程序中提供 Swagger UI 所需的一切。

如果您正在构建单页应用程序，我们强烈建议您使用 swagger-ui 而不是 swagger-ui-dist，因为 swagger-ui-dist 非常大。

兼容性

自 2010 年初创建以来，OpenAPI 规范已经过 5 次修订。Swagger UI 和 OpenAPI 规范的兼容性如下

文档

使用

• 安装
• 配置
• CORS
• OAuth2
• 深度链接
• 限制
• 版本检测

自定义

• 概述
• 插件 API
• 自定义布局

开发

• 设置
• 脚本

集成测试

按照此处说明，您需要 JDK 7 或更高版本 https://nightwatch.node.org.cn/gettingstarted#selenium-server-setup

可以使用 npm run e2e 在本地运行集成测试 - 确保在测试时没有运行开发服务器！

浏览器支持

Swagger UI 在最新的 Chrome、Safari、Firefox、Edge 和 IE11 版本中工作。

已知问题

为了帮助迁移，以下是当前与 3.X 相关的已知问题。此列表将定期更新，并且不会包括未在先前版本中实现的功能。

• 以前支持的部分参数现在可用。
• JSON 表单编辑器未实现。
• 对 collectionFormat 的支持是部分性的。
• l10n（翻译）未实现。
• 对外部文件的相对路径支持未实现。

安全联系

请通过电子邮件 security@swagger.io 披露任何与安全相关的问题或漏洞，而不是使用公共问题跟踪器。

许可证

版权所有 2019 SmartBear Software

根据 Apache 许可证 2.0 版（“许可证”）许可；除非遵守许可证，否则您不得使用此文件。您可以在 apache.org/licenses/LICENSE-2.0 获得许可证的副本。

除非适用法律要求或书面同意，否则在许可证下分发的软件是基于“现状”原则分发的，不提供任何形式的保证或条件，无论是明示的还是暗示的。请参阅许可证以了解具体的管理许可和限制的语言。