Swagger 2.0 在哪里声明基本身份验证模式
如何使用 Swagger 2.0 注释定义基本身份验证并使其显示在 swagger UI 中. 在我拥有的资源中: @ApiOperation(value = "返回类别列表", response=Category.class, responseContainer="List", httpMethod="GET", authorizations = {@Authorization(valu
..
swagger-2.0相关内容
我们可以使用 swagger-generator 在模型变量上生成 @JsonFormat 吗?
我在 yml 文件中有一个变量 开始日期:类型:字符串格式:日期 我正在使用 swagger-generator 从 yml 生成 java 代码. 它正在生成一个 startDate 变量，如下所示 @JsonProperty("startDate")private LocalDate startDate = null; 但我需要如下 @JsonProperty("startDa
..
在 Swagger 2.0 中定义多个模型的数组
这是我第一次接触 Swagger，所以请保持温和. 我有以下定义: 定义:有效载荷:类型:对象特性:指标:类型:数组项目:$ref: '#/定义/指标'指标:类型:对象特性:类型:类型:字符串计算:类型:数组项目:类型:字符串默认:- 关闭参数:类型:对象带:特性:类型:类型:字符串默认:BBANDS计算:类型:数组项目:类型:字符串默认:- 关闭参数:类型:对象特性:时间段:类型:整数格
..
Swagger:支持可选路由
我有一个带有可选参数的路由: [Route("{categoryId?}")]公共 HttpResponseMessage Get(int? categoryId=null) 但是，当我没有为 categoryId 提供值时，调用在请求本身中包含 {categoryId?}... http://myhost/api/%7BcategoryId%7D 解决方案 Swagger 不支持可选
..
如何定义 Swagger 2.0 JSON 以填充 Swagger UI 中的默认正文参数对象?
我们当前的部署模式要求我手动编写我的 swagger json 输出，这些输出将由我公司使用的基于 Swagger 的 UI 使用.我希望我正在编写的 json 提供“默认"值来填充所有输入字段的 Swagger UI，包括 body 输入参数.我的 body 参数是一个引用对象，如下所示.我如何定义返回的 swagger JSON 以在单击“尝试此操作"时自动填充请求的正文部分? 在 Sw
..
如何在 Swagger 中定义角色/权限安全
在我的 API 文档中，我想定义每个 API 端点所需的安全性.该项目已定义角色和权限，以确定哪些用户可以访问 API.Swagger 中记录此信息的最佳方式是什么?是否有关于如何显示此详细信息的最佳做法或建议? 这是我使用 securityDefinitions 和角色自定义变量尝试的，但是当我通过 swagger2markup 或使用 swagger-ui 运行它时，该信息(x-role
..
在 Swagger 2.0 中为数组定义枚举
type": "数组",“项目": {“类型":“字符串"，“枚举":[“男"，“女"，“工人"]} 或 type": "数组",“项目": {“类型":“字符串"，},“枚举":[“男"，“女"，“工人"] ? 规范中没有关于此的任何内容.目标当然是让 swagger-ui 显示枚举值. 解决方案 第一种情况是正确的，现在 swagger-ui 生成枚举值的多项选择.
..
如何在 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
..
Swagger UI 未正确发送数组
我正在尝试发送多个值(一个数组)(请参阅规范中的第 93 行 ->... 名称:收件人 [] ...) 我面临的问题是 Swagger-ui 调用端点如下: 实际 收件人[]=value1%2Cvalue2 预期 recipients[]=value1&recipients[]=value2 %2C 表示 ,(逗号). 以下是所需的详细信息招摇-ui 版本 2.1.1以下
..
如何链接到 Swagger 中的另一个端点
我正在为未来的公共 API 编写 Swagger 规范，该规范需要非常详细和清晰的文档.有没有办法在 swagger.yml 文件中的其他位置引用/链接/指向另一个端点? 例如，这是我想要实现的目标: 路径:/我的/端点:邮政:标签:- 一些标签总结:做事描述:>这个端点做事.看到/my/otherEndpoint 的东西 # 这里我想要某种超链接操作 ID:做事消耗:- 应用程序/js
..
对象数组作为 swagger 中的输入参数
我正在尝试用 swagger 描述以下 post 参数: {“来源":[{“身份证":101，“parentId":201},{“身份证":102，“parentId":201},{“身份证":102，“parentId":202}],“目的地ID":301，"param1": "值 1","param2": "值 2",} 问题在于 sources 是一个对象数组，该 swagger 似乎不
..
昂首阔步;根据可选参数指定具有相同代码的两个响应
这个问题不是 (Swagger - 指定可选对象属性或多重响应)，因为该 OP 试图返回 200 或 400. 我有一个带有可选参数的 GET；例如，GET/endpoint?selector=foo. 我想返回一个 200，其架构根据是否传递参数而有所不同，例如: GET/endpoint ->{200，schema_1}GET/endpoint?selector=blah ->{
..
如何生成 swagger.json
我正在使用 java spring boot 框架为我的项目创建 REST api，我正在使用“springfox-swagger2 和 springfox-swagger-ui"来生成 swagger 文档.我可以使用 URL http://localhost:8080/swagger-ui.html. 我如何创建或生成 swagger.json/spec.json，文档不应与此应用程序一
..
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(我可以在浏览器的检查器
..
Swagger:取决于字段值的变体模式形状
我有一个模型定义为: 事件:类型:对象特性:ID:类型:字符串时间戳:类型:字符串格式:日期时间类型:类型:字符串枚举:- 点击- 打开- 发送点击:类型:对象特性:网址:类型:字符串标题:类型:字符串打开:类型:对象特性:主题:类型:字符串发送:类型:对象特性:主题:类型:字符串从:类型:字符串到:类型:字符串 然而，实际上根据 type 枚举字段的值，形状是不同的.它可以是三个之一，我试图
..
Swagger 2.0 Anyof
Swagger 2.0 版中 anyof 的等价物是什么，请告诉我如何更新我的 json 文件，因为我想将我的文档从 swagger 1.0 升级到 2.0. 感谢您的帮助. 解决方案 我认为没有，感觉是一个很大的缺点.规范的架构对象部分中绝对没有提到它.他们调用了从 JSON Schema 中采用的元素，anyOf 不在其中: 以下属性直接取自 JSON Schema 定义并
..
如何在某些操作而不是其他操作所需的定义中创建字段
我正在用 yaml 编写我的 swagger 定义.假设我有一个看起来像这样的定义. 路径:/有效载荷:邮政:摘要:创建有效负载...参数:- 在:身体名称:有效载荷描述:新的有效载荷要求:真实架构:$ref: "#/定义/有效载荷"放:摘要:更新有效负载...参数:- 在:身体名称:有效载荷描述:更新了现有的有效载荷要求:真实架构:$ref: "#/定义/有效载荷"...定义:有效载荷:特性
..
如何将 swagger 2.0 JSON 文件分解为多个模块
我正在尝试将我的 API 文档分解为多个可以独立编辑的 JSON 文件.我能找到的所有示例都使用 Swagger 1.2 模式，它有一个“api":{} 对象来分解它.2.0 模式中似乎缺少这一点(http://json.schemastore.org/swagger-2.0一>).所定义的只是一个“路径"数组，它将所有 API 端点捆绑到该单个数组中.这在 swagger-ui 中的效果是有一个
..
Swagger:重用枚举定义作为查询参数
我想使用 definitions 中定义的枚举作为查询字符串中参数定义的一部分. 我在 Swagger 2.0 规范文件的 definitions 部分定义了 Swagger 枚举. 操作类型:类型:字符串枚举:- 登记- 更新 我可以在其他定义中创建对它的引用: 操作:类型:对象特性:姓名:类型:字符串类型:$ref: '#/定义/操作类型' 当参数为 in: body 时，我可以
..
Swagger:通配符路径参数
我有一个允许传入任意路径的 API，例如所有这些: /api/tags /api/tags/foo /api/tags/foo/bar/baz 是有效路径.我试着这样描述: /tags{tag_path}:得到:参数:- 名称:tag_path在:路径要求:真实类型:字符串默认: "/" 但是，https://generator.swagger.io 对路径中的斜杠进行编码，因
..