swagger相关内容

优先使用api或api

我已经阅读了swagger定义和格式,并了解到swagger定义用于描述API. 最好先编写swagger定义,然后再编写API?还是先写API然后大张旗鼓?我对此没有经验,我想为应用程序编写一个REST API和一个swagger文件. 解决方案 我认为顺序并不重要.Swagger 入门指南中赋予了这两种方法合法性.关键是,一个应该从另一个生成,因此您不必手动维护这两个. 在 ..
发布时间:2021-04-08 20:38:46 其他开发

Swagger @ApiModelProperty示例值null(对于Long)

我将 SpringFox 和Swagger UI用于API文档. 我有一个DTO,其中有一个类型为Long的属性.它没有99%的时间被填充,因此我想通过将属性值设置为 null 来在文档中证明这一事实.所以我想在示例部分中使用此JSON {/* ... */"legacyId":null} 我已经尝试过 @ApiModelProperty(值="legacyId",示例= null) ..
发布时间:2021-04-07 20:09:54 Java开发

如何在整个Swagger YAML文档中重复使用我的x-amazon-apigateway-integration定义?

我目前正在使用Swagger定义具有许多端点的API,并且这些端点中的每一个都对"x-amazon-apigateway-integration"键具有相同的定义.我想在文档中的某个位置定义此名称,然后在整个过程中重复使用该定义. 要么我不理解应该如何定义定义,要么我没有将其放置在正确的位置,也没有将二者结合在一起.我尝试在“定义"中定义此定义,并在其自己的键下定义一些别名.定义(删除了关键 ..
发布时间:2021-04-03 19:45:05 其他开发

大张旗鼓地为通用控制器添加文档和操作

我正在使用带插件的webapi.添加插件后,我想更新swagger文档.当我不使用版本时,我可以处理.所有方法都添加到了swagger文档中. 但是当api开启apiversion时,新版本swagger文档的生成失败.返回404. 我是否需要做任何事情以使版本工作并获得动态控制器功能... 私有字符串AddSwaggerVersionDocument(PluginMetadata元 ..
发布时间:2021-04-02 18:48:58 C#/.NET

如何通过控制器名称对NSwag swagger.json中的路径进行排序/排序

我正在使用NSwag为.NET Core API生成招摇工具,并且一切正常,除了渲染路径以使反射似乎将Controller从项目中提取这一事实之外. 因此,如果我确实具有层次结构-某些控制器位于根级别( Controllers 文件夹),而某些位于子文件夹( Controllers \ Subfolder 文件夹),则顺序会混乱. 是否可以通过某种方式告诉NSwag生成结果 swagg ..
发布时间:2021-04-02 18:45:55 C#/.NET

我们如何通过Windows身份验证保护Swagger UI

我们有一个.net Core 2.2 Web Api,它使用swagger ui公开Web Api定义.我们希望将此端点仅保护给特定AD组内​​的用户.我们目前正在同时使用Windows和匿名身份验证.问题是我们无法强制Swagger使用Windows身份验证来阻止用户. 有什么想法吗? 解决方案 尽管令人沮丧,但到目前为止,我发现保护Swagger端点(通过Swashbuckle) ..
发布时间:2021-04-02 18:41:03 其他开发

JSON模式-不同对象的数组

我想知道如何为不同对象的数组指定JSON模式. 此线程给了我答案的一半,但是当我有每种对象的多个实例时失败. 这是基于产品"对象:- { "things": [ { "entityType" : "Product", "name" : "Pepsi Cola", "brand" : "pepsi" }, { " ..
发布时间:2021-02-14 18:42:41 其他开发

如何从Swagger API声明生成JSON-Schema

我有使用 Swagger v 1.2 我对Swagger的最初感觉是,它非常接近JSON Schema(草案3和最近的Draft 4),并且为请求和响应对象生成JSON Schema相对容易. 但是,尽管Swagger的一部分重用了JSON Schema结构,但事实证明,它仅使用功能的子集,并且还在Models中引入了它自己的继承(使用subTypes和discriminator). ..
发布时间:2021-02-14 18:42:09 其他开发

有没有一种方法可以将Swagger仅用于验证而无需使用整个框架?

假设我有一个实现JSON HTTP API的现有Java服务,并且我想添加一个Swagger模式并针对它自动验证请求和响应,而无需重新构建该服务以使用Swagger框架/代码生成.有没有提供我可以绑定的Java API并传递有关请求/响应的信息以进行验证? (仅使用JSON模式验证器就意味着在Swagger中手动实现许多其他功能.) 解决方案 我认为没有单独准备做任何事情的方法,但是 ..
发布时间:2021-02-14 18:42:03 其他开发

C#库,用于将JSON模式转换为示例JSON

我正在寻找一个C#库,该库将基于给定的JSON模式生成一个有效的JSON对象.我想生成一个非常简单的JSON示例,就像 Swagger 那样做: 我已经看到了一些JavaScript库,例如 JSON Schema Faker ,但是我需要一个C# /.Net库,可以在我的后端代码中生成示例JSON. 解决方案 好,它非常简单,没有考虑JSON模式的许多因素,但对于您来说可能是一个足 ..
发布时间:2021-02-14 18:31:30 其他开发