swagger-ui相关内容

node.js 上 swagger 中的可为空字段

我花了很多时间试图找到在 Node.JS 中创建 swagger 文档的解决方案.主库是 swagger-node,您可以在其中创建一个 swagger yaml 文件,然后向其中添加控制器.它会自动在您的应用程序中提供 swagger ui 文档并对请求进行验证和验证.响应您在 yaml 中指定的模型. 这很好,但是我有一个要求,我希望某些字段能够明确返回或接受 null 作为值,例如: ..
发布时间:2021-09-01 20:13:12 其他开发

如何在 Swagger UI 中通过请求发送 Authorization 标头?

我有一个 ASP.NET Web Api 2 应用程序.我向其中添加了 Swashbuckle(用于 .NET 的 Swagger).它显示我的端点没问题,但为了发送请求,我需要将授权标头附加到该请求.如果我理解正确,我需要修改 index.html 文件 (https://github.com/swagger-api/swagger-ui#how-to-use-it) 所以我 git 克隆了 S ..
发布时间:2021-09-01 20:13:05 其他开发

在 Swashbuckle 中启用不记名令牌(Swagger 文档)

我创建了一个使用个人帐户安全的 asp.net webapi 应用程序,以便默认情况下启用不记名令牌.它运行良好,因此我可以毫无问题地在 Postman 中测试它们. 当我尝试通过 Swashbuckle 集成 Swagger UI 时出现了问题.我通过以下方式安装了 Swashbuckle: 安装包 Swashbuckle 然后更改SwaggerConfig.cs: Glob ..
发布时间:2021-09-01 20:12:59 其他开发

Swagger UI 未正确发送数组

我正在尝试发送多个值(一个数组)(请参阅规范中的第 93 行 ->... 名称:收件人 [] ...) 我面临的问题是 Swagger-ui 调用端点如下: 实际 收件人[]=value1%2Cvalue2 预期 recipients[]=value1&recipients[]=value2 %2C 表示 ,(逗号). 以下是所需的详细信息招摇-ui 版本 2.1.1以下 ..
发布时间:2021-09-01 20:12:57 其他开发

SwaggerUI:路径显示“默认".我怎样才能改变?

我从 http://editor.swagger.io 下载了示例服务器程序.(Swagger Petstore(简单),NodeJS) 然后我部署到我的服务器,但路径显示为“默认".我该如何更改? 此示例显示了路径的名称.这就是我想要做的.http://petstore.swagger.io/#/ package.json “依赖项":{“连接":“^3.2.0","js-y ..
发布时间:2021-09-01 20:12:54 其他开发

Swagger:使用 ref 添加描述

我想向引用其定义的对象属性添加描述.类似的东西: 新信用卡:类型:对象特性:计费电话:描述:持卡人电话$ref: "#/定义/电话号码" 但编辑器警告将跳过描述属性: 额外的 JSON 参考属性将被忽略:描述 我发现了一个不太优雅的解决方法,它适用于编辑器,但不适用于 Swagger UI(不确定这可能是由于最近更新到 3.0.2 版本的 Swagger UI) 新信用卡:类型:对象 ..
发布时间:2021-09-01 20:12:40 其他开发

如何生成 swagger.json

我正在使用 java spring boot 框架为我的项目创建 REST api,我正在使用“springfox-swagger2 和 springfox-swagger-ui"来生成 swagger 文档.我可以使用 URL http://localhost:8080/swagger-ui.html. 我如何创建或生成 swagger.json/spec.json,文档不应与此应用程序一 ..
发布时间:2021-09-01 20:12:26 其他开发

Swagger UI - "类型错误:无法获取"有效回应

我刚刚使用以下命令从 Git 存储库 (3.0.19) 中提取了最新的 Swagger:https://github.com/swagger-api/swagger-ui.git 并更新了我的 API 以使用新版本. 跑 git describe --tags 确认,我的版本目前是:v3.0.19-6-gaab1403 我遇到的问题是此处,其中我的响应是 403(我可以在浏览器的检查器 ..
发布时间:2021-09-01 20:12:20 其他开发

Swagger/Swashbuckle:具有资源所有者密码凭据授予的 OAuth2

我正在尝试将 Swashbuckle 5.0.x 与 OAuth2 结合使用.我想使用 OAuth2 的资源所有者密码凭据授予.我基本上只想先请求一个令牌,然后在每个请求中包含这个令牌(例如不需要范围). 有人可以帮忙吗?我必须如何配置 swagger/swashbuckle? 解决方案 好的,我是这样解决的: 为 swagger 添加一个 JavaScript 完成处理程序: ..
发布时间:2021-09-01 20:12:17 其他开发

如何在我的应用程序中集成 swagger-ui

我正在尝试将 swagger 与骆驼项目集成 按照这个例子https://github.com/smparekh/camel-示例-servlet-rest-tomcat 如何使用此示例项目访问 swagger-ui? 我在tomcat中删除了war文件. 并访问 http://localhost:8080/camel-example-servlet-rest-tomcat ..
发布时间:2021-09-01 20:12:01 其他开发

如何将 swagger 2.0 JSON 文件分解为多个模块

我正在尝试将我的 API 文档分解为多个可以独立编辑的 JSON 文件.我能找到的所有示例都使用 Swagger 1.2 模式,它有一个“api":{} 对象来分解它.2.0 模式中似乎缺少这一点(http://json.schemastore.org/swagger-2.0一>).所定义的只是一个“路径"数组,它将所有 API 端点捆绑到该单个数组中.这在 swagger-ui 中的效果是有一个 ..
发布时间:2021-09-01 20:11:47 其他开发

Swagger:通配符路径参数

我有一个允许传入任意路径的 API,例如所有这些: /api/tags /api/tags/foo /api/tags/foo/bar/baz 是有效路径.我试着这样描述: /tags{tag_path}:得到:参数:- 名称:tag_path在:路径要求:真实类型:字符串默认: "/" 但是,https://generator.swagger.io 对路径中的斜杠进行编码,因 ..
发布时间:2021-09-01 20:11:35 其他开发

具有查询字符串的 Swagger API

我想部署一个带有查询字符串的 API.这就是 API v1/products?q=断路器&locale=en-GB&pageSize=8&pageNo=1&project=GLOBAL 这是我的实施方式 "/v1/products?q={searchText}&locale={ctrCode}&pageSize={pageSize}&pageNo={pageNo}&project={proj ..
发布时间:2021-09-01 20:11:32 其他开发

在 swagger 文档中使用对象类型查询参数

我有一个 GET 路由,我想将 url 中的对象参数编码为查询字符串. 在编写 swagger 文档时,我基本上会遇到错误,这些错误不允许我在 query 类型参数中使用 schema/object 类型: 路径:/我自己的路/:得到:参数- 在:路径名称:someParam描述:一些有效的参数要求:真实类型:字符串格式:timeuuid #good param,效果很好- $ref: ..
发布时间:2021-09-01 20:11:29 其他开发

结合 Swagger 文档中的定义

我正在用 Swagger 文档记录 API.我有几个端点共享一组通用的基本属性.我想使用 $ref 来引用该基本属性集,然后使用每个端点独有的附加属性扩展这些属性.我想象它会像这样工作,但这是无效的: “属性":{"$ref": "#/definitions/baseProperties",独特的东西":{“类型":“字符串"},“another_unique_thing":{“类型":“字符串 ..
发布时间:2021-09-01 20:11:27 其他开发

如何从 Swagger UI 导出 Swagger JSON/YAML 文件?

如何导出 Swagger 定义文件(应该是 JSON 或 YAML 文件)? 假设我有一个看起来像 http://example.com//swagger/ui/index#! 的端点: 版本为api version: v1. 没有“导出"我可以看到的按钮.那么如何导出呢? 解决方案 API 定义的 URL 显示在 Swagger UI 的顶部栏中 - 在您的示例中是 ..
发布时间:2021-09-01 20:11:15 其他开发

未在 Swagger UI 中生成的 Spring Data REST 端点

我已经使用 @BasePathAwareController 实现了一个控制器,它也利用了 Spring Data REST(用于显示排序/大小等的发现)以及一些自定义端点(用于更新等).应用程序按预期工作,端点 SpringREST 生成的数据按预期工作,我可以看到响应中出现自链接,但是,我看不到Swagger UI 中的这些端点.我只能看到我的自定义端点在我的控制器中定义. 根据这个帖子 ..

Spring Boot Swagger HTML 文档未显示

我正在使用 Spring Boot 设置 REST API/微服务项目.我也在尝试启用 swagger 文档.当我运行 spring boot 应用程序时,我可以看到浏览到 localhost:8080/v2/api-docs 并返回 API 文档.但是,当我尝试浏览 http://localhost:8080/documentation/swagger-ui.html 或 http://loca ..
发布时间:2021-08-20 20:00:03 其他开发