swagger相关内容
我正在尝试使用 Swagger 来描述我正在构建的 web-api.问题是我看不懂如何描述复杂的json对象? 例如,如何描述这个对象: {名称:“乔恩",地址: [{类型:“家",line1:“第一街"},{类型:“办公室",第 1 行:“第二街"}]} 解决方案 好的,所以根据上面的评论,您需要以下架构: {“定义":{“用户":{“类型":“对象",“必需":[“名称"],“特
..
我们有 asp.net 核心 webapi.我们添加了 Microsoft.AspNetCore.Mvc.Versioning 和 Swashbuckle 以拥有 swagger UI.我们将控制器指定为: [ApiVersion("1.0")][Route("api/v{version:apiVersion}/[controller]")]公共类 ContactController : 控制器
..
..
我必须记录我的 API.我必须使用其中任何一个 Slate 或 Swagger.我想知道哪个有更多的选择,利弊,哪个更好. 解决方案 Swagger 和 Slate 有两个不同的用途.Swagger 是一种描述 RESTful API 的标准化方式的尝试(例如,类似于 ApiBlueprint) Swagger 是一种基于 JSON 的 API 定义格式,允许描述 REST API.
..
我有使用 Swagger v 1.2. 我对 Swagger 的最初感觉是它非常接近 JSON Schema(草案 3 和最近的草案 4),并且为请求和响应对象生成 JSON Schema 应该相对容易. 然而,虽然 Swagger 的一部分重用了 JSON Schema 结构,但事实证明它只使用了一部分功能,并且还在 Models 中引入了自己的继承(使用 subTypes 和 鉴别
..
我刚刚大摇大摆地生成了一个有效的 swagger.json.我使用 Application-config 方法配置了招摇.但是,一旦我覆盖 getClasses-Method 以添加招摇资源,我的 JAX-RS 路径注释类就会停止工作.方法是这样的 @Override公共设置>获取类(){设置>资源 = 新的 HashSet();资源.add(io.swagger
..
我在 IBM Integration Bus 中工作,我发现 myslef 需要验证我收到的消息.由于 IIB 在这方面不支持任何类型的验证,我想知道是否有任何外部库可以为我验证这些消息. 到目前为止,我发现了这个 https://github.com/swagger-api/swagger-inflector/blob/master/README.md#payload-validation
..
如何为这个示例 post API 定义 swagger 注释.TenantConfiguration 正在获取为 json 有效负载. @Consumes({ "application/json", "application/xml" })@邮政public Message configureSettings(TenantConfiguration 配置)抛出 AndroidAgentExcep
..
我正在使用 RestTemplate 调用 AutoTask API.但是,我收到一条错误消息: 500 Internal Server Error: [{"errors":[""Unexpected character met while paring value: %.路径 '',第 0 行,位置 0."]}] API 调用的 Swagger UI 截图(成功) 控制台输出(错误)
..
是否可以在操作分组中包含子部分?我们目前使用基于控制器的微分来分组功能,但托管了大量控制器并且可以使用进一步的嵌套. 换句话说,我知道动作可以按以下方式分组/排序,但可以多次分组: c.GroupActionsBy(apiDesc => apiDesc.HttpMethod.ToString());c.OrderActionGroupsBy(new DescendingAlphabet
..
我正在开发一个 API,我们在 swagger.yaml 文件中定义 API 定义.我正在处理的 API 返回一个包含地图的输出对象. 输出对象:输出类 public class OutputClass {私有地图地图;} 现在,我用过: 输出类:类型:对象附加属性:$ref: '#/definitions/MapValue' 但 Swagger Codegen
..
是否有某种标准可供人们用来记录他们的库和框架? 理想情况下,它会使用 JSON 或 YAML,并允许生成呈现精美的 HTML 页面. 解决方案 SDK 文档最常见的方法是从源代码中的注释生成文档.这样,类/函数参考文档可以轻松地与实现保持同步. 有针对不同编程语言和框架的文档生成器.一些工具可以让您将生成的参考文档与手动编写的概念主题(概述、“入门"等)结合起来 一些流行
..
我正在尝试将 swagger 客户端集成到我的项目中.我能够从大摇大摆地生成课程.Swagger for swift 3 使用 Alamofire 进行其 newtork 操作.问题是生成的类名称之一是“响应".Alamofire 内部具有相同的类.当我添加这些类并尝试构建时,我有很多错误抱怨重新声明类.在这种情况下我能做什么?我是否必须从服务器端更改才能获得“响应"类? 解决方案 您应该
..
如何使用 RestSharp 客户端连接到 Ambari 的 Swagger 界面? 此代码有效并返回预期的 json: HttpClientHandler 处理程序 = 新的 HttpClientHandler{Credentials = new System.Net.NetworkCredential("xxx", "yyyyy")};使用 (var httpClient = new
..
假设我有一个实现 JSON HTTP API 的现有 Java 服务,并且我想添加一个 Swagger 模式并自动验证针对它的请求和响应,而不需要对服务进行重组以使用 Swagger 框架/代码生成.有什么东西可以提供 Java API,我可以绑定并传递有关请求/响应的信息以进行验证? (仅使用 JSON 模式验证器将意味着在 Swagger 中手动实现许多附加功能.) 解决方案 我
..
我有一个带有身份验证服务的简单 REST 应用程序.我尝试向其中添加 swagger 和 swagger-ui,但我只能在 /v2/api-docs 中看到我的端点.在 swagger-ui.html 我只看到一组端点,但我无法扩展任何列表. 在 chrome 调试中我看到: 加载资源失败:服务器响应状态为401() 未捕获的类型错误:无法读取未定义的属性“indexOf"
..
更新 2:如果我从这里更改我的控制器授权标签 [授权] 到这里 [授权(角色=“读取")] 然后我得到范围选择的复选框,并且 ajax 令牌请求包含正确的范围并成功完成.然而,我仍然以红色感叹号结束.看起来 Swagger 或 Swashbuckle 要求角色与范围定义匹配?使用 Swashbuckle 时是否可以使用未定义角色的应用程序流?如果是这样,您如何使其工作?我是否必须在操作过滤
..
我使用 Swagger 定义创建了一个 REST API,现在我需要使用该 swagger 模式来验证传入消息.我找到了几种解决方案,但是它们都依赖于一些特定的用例.最接近我需要的是 this 和真实的描述它适用于提供的 json 模式,但是当我提供更复杂的招摇定义时,它只是将所有内容标记为有效.我的问题是.是否有任何更好、更完整或更称职的解决方案(也许是库)可以根据 Swagger 定义本地验证
..
我正在使用 swagger 3.0,并且在 swagger 文档中有多个端点. 我希望用户不要每次都在授权按钮处输入凭据. 有什么方法可以在 index.html 或我的 yaml 文件中包含身份验证以自动授权用户. 谢谢. 解决方案 Swagger UI 3.13.0+ 为此提供了 preauthorizeBasic 方法.假设您的 API 定义包含基本身份验证的安全方
..
我如何表明在 my_object 中可以有 property_1 或 property_2,但不能同时有? my_object:类型:对象特性:属性_1:类型:字符串属性_2:类型:字符串 解决方案 你可能想切换到OpenAPI 3.0,它支持oneOf关键字定义互斥条件: 这是一个例子: my_object:类型:对象特性:属性_1:类型:字符串属性_2:类型:整数一个:- 必需
..