swagger相关内容

如何在ASP.NET Core中更改Swagger的基本URL

默认情况下,当您在ASP.NET Core项目中启用摇摇欲坠时,它可以在url上使用: http://localhost:/swagger/ui 我想使用其他基本URL代替/swagger/ui.我如何/在哪里配置? 我发现对于较旧的版本,您可以配置RootUrl,但是ASP.NET Core中没有类似的方法: .EnableSwagger(c => ..
发布时间:2020-09-08 21:14:09 C#/.NET

我该如何指定swagger的默认打开版本?

我有一个使用Swagger作为API文档的C#Web API.我已经使用了Swashbuckle软件包. swagger环境可与我在控制器中指定的多个版本一起使用. 今天,我介绍了一个仍在开发中的新的未来版本(1.2).我想默认在1.1版上打开swagger,但仍在右上角的下拉列表中保留正确的排序顺序(例如v1,v1.1,v1.2).目前,它始终会在下拉菜单中打开最高版本. 有人知道怎 ..
发布时间:2020-09-08 20:56:20 C#/.NET

Swagger(Asp.Net Core)是否有控制器描述?

我正在构建一个REST服务,它将托管多个控制器(微服务).总体而言,我们将服务称为“鲍勃".因此大张旗鼓地显示“鲍勃"/“鲍勃微服务的集合".然后列出了控制器名称.现在,它仅显示XYZ,ABC等.是否有办法大张旗鼓地显示"XYZ-XYZ API的集合"或类似内容? 好像招摇似地在方法上显示了///,但在控制器上却未显示. 解决方案 有没有办法大张旗鼓地显示"XYZ-XYZ API ..
发布时间:2020-09-08 20:51:08 C#/.NET

ASP.NET Core-Swashbuckle不创建swagger.json文件

我在获取Swashbuckle.AspNetCore(1.0.0)包来生成任何输出时遇到麻烦.我阅读了swagger.json文件,应将其写入“〜/swagger/docs/v1".但是,我没有得到任何输出. 我从一个全新的ASP.NET Core API项目开始.我应该提到这是ASP.NET Core2.该API可以正常工作,并且我能够从值控制器中检索值就可以了. 我的启动类具有与本 ..
发布时间:2020-09-08 20:28:13 C#/.NET

完全替换Swashbuckle UI

现在,我正在开发ASP.Net Web API,并使用Swashbuckle作为其文档. 我知道Swashbuckle在内部使用Swagger-UI,我知道我们可以通过注入CSS或javascript文件来修改布局,甚至可以更改index.html的布局. 我为Swagger-UI找到了一个很好的主题 https://github.com/jensoleg/swagger-ui 并尝试实现它 ..
发布时间:2020-09-08 00:14:17 C#/.NET

摇摇欲坠的对象数组

我有些招摇不定:.yaml文件中有一个以这种方式描述的对象(地址)数组: Address: properties: street: type: string city: type: string state: type: string country: type: string 这是另一个具有API定义的 ..
发布时间:2020-09-07 05:58:54 其他开发

我的产品中的Swagger-YAML错误映射条目

大家好,我在使用YAML时遇到困难,需要您的帮助. 我有这段代码,它给了我错误,并且我找不到我在哪里或做错了.我收到的错误消息在下面 /product/{productid}/fabric/{fabricid}: get: tags: - "Product" summary: "Get Fabric by Id" description: "This endpoint di ..
发布时间:2020-09-05 23:04:52 其他开发

在SwaggerUI中包括客户端SDK使用示例

我一直在寻找一种工具,该工具可以帮助我解析JSON swagger文件(甚至YAML文件)并基于我已经尝试过: codegen(所以我确实在github存储库中有代码示例,但是我不知道如何在我的UI上动态获取它) 石板,但我想继续大张旗鼓 Widdershins 有人知道能够产生这种功能的第三方工具吗,还是我错过了Codegen或swagger-UI的某些东西? 还是应该在页面中 ..

在指定其他响应类型的同时自动生成默认的200 OK响应

根据#216 ,Swashbuckle将自动生成200成功响应作为默认行为,否则期望指定所有响应类型. 我希望能够向XML注释中的某些端点添加404/400错误响应,同时为所有端点(包括具有404/400错误响应的端点)保留200个成功响应. 即使指定了错误响应,是否也可以使Swashbuckle继续为所有端点自动生成200成功响应? 编辑:我添加了一个操作过滤器,以编程方式添加 ..
发布时间:2020-09-05 22:09:50 C#/.NET

关于Swagger API的建议

我正在使用Java 8使用SpringBoot和Spring REST服务构建API,我刚刚发现了Swagger API,现在我想使我的API Swagger兼容. 据我了解,Swagger是记录您的APIS的工具,除了提供与API交互的漂亮Web界面外,还提供了从规范(第2版中的swagger.json)生成客户端和服务器代码的功能. 现在,鉴于我已经具有至少15个控制器的现有API ..
发布时间:2020-09-05 21:57:44 Java开发

在MVC网络核心中找不到Swagger页面404

我有一个全新的.NET-Core Web API项目,我想使用API​​版本控制和扩展功能. 当我尝试查看摇摇欲坠的页面时,我得到了404.但是,模板随附的默认ValuesController起作用. 这是我的设置: Startup.cs public void ConfigureServices(IServiceCollection services) { ..
发布时间:2020-09-05 21:41:44 C#/.NET

如何共享Swagger文档

我最近开始将Swagger用于我的文档,但是对我来说仍然有些事情还不清楚.我创建了YAML文档,现在我希望能够与团队其他成员共享.pdf或HTML/Javascript页面中的文档.我不能使用SwaggerHub,因为它们没有私有存储库,并且Swagger Editor似乎不允许共享右侧的面板. 请明确一点,我希望能够得到类似的东西: 我想念什么? 解决方案 DynamicAp ..
发布时间:2020-09-05 20:45:44 前端开发

使用HTTP内容上传的API文件上传不大张旗鼓

我正在将swagger接口实现到现有的Web API中.当前的API控制器公开了一个异步上传功能,该功能使用Request.Content异步传输图像. 这篇文章. 我的api控制器: [HttpPost] [Route("foo/bar/upload")] public async Task Upload() ..
发布时间:2020-09-05 20:29:13 C#/.NET

openAPI 3.0未显示API端点的“试用"按钮

不幸的是,我已经使用swagger openapi3.0配置了我的api,不幸的是,它没有显示我的API端点的try it out按钮.我是否缺少swagger文件中的任何配置?谁能帮我解决这个错误? 注意:我正在使用开放式API3.0 这是我使用的配置: { "openapi": "3.0.0", "info": { "version": "1.0.0", "ti ..
发布时间:2020-09-05 19:28:50 其他开发

如何在Swagger的测试中验证API?

我正在尝试找出使我的API文档成为真相的最佳方法,并理想地通过集成测试或类似的方式使用它来验证实际的Java REST代码.我们使用的是“合同优先"或“消费者合同"类型的方法,因此我们不希望文档必须从带注释的代码中生成,并且每次开发人员进行更改时都进行更新. 一个想法是使用Swagger,但是我不确定如何最好地使用它来验证API.理想情况下,最好在构建或集成测试过程中进行验证,以查看实际响应 ..
发布时间:2020-09-05 19:15:36 Java开发

如何在Swagger UI中发送带有请求的自定义标头?

我在API中有一些终结点-/user/login,/products. 在Swagger用户界面中,我将email和password发布到/user/login,作为响应,我收到了token字符串. 然后,我可以从响应中复制令牌,并希望将其用作请求中所有URL的请求中的Authorization标头值,并以/products为例. 我应该在Swagger UI页面上的某个位置手动 ..
发布时间:2020-09-05 19:11:28 其他开发

Swagger的RESTful API测试平台

我正在尝试为REST API开发自动化测试套件.有人告诉我Swagger是用于执行此操作的正确工具. 该API正在使用Spring框架进行开发. 我不知道如何使用Swagger来做到这一点. 根据我的理解,Swagger用于创建不错的API文档. 我看过此Dreamfactory博客文章,看起来他们已经具有某种浏览器测试功能,但我认为它并不是真正的测试套件. 我也研究了ServiceS ..
发布时间:2020-09-05 19:06:48 其他开发