Swashbuckle启动期间通过Config.MapRoute创建的路由的Swagger文档？
Swashbuckle是一个用于ASP.NET Web API的开源库，它可以帮助我们在API开发过程中生成和展示Swagger文档。Swagger是一种用于描述和定义RESTful风格的API的规范，它提供了一种统一的方式来描述API的输入参数、输出结果、错误码等信息。
在Swashbuckle启动期间，通过Config.MapRoute创建的路由会在Swagger文档中展示为API的一个路径。Config.MapRoute是ASP.NET MVC框架中用于配置路由的方法，它可以将URL路径映射到相应的控制器和动作方法上。
Swagger文档对于API的开发和使用非常有帮助，它可以提供以下信息：
- API的路径和HTTP方法：Swagger文档会列出API的路径和支持的HTTP方法，例如GET、POST、PUT、DELETE等。
- 输入参数和请求体：Swagger文档会描述API的输入参数，包括参数名称、类型、是否必需等信息。对于POST和PUT请求，还会描述请求体的结构和字段。
- 输出结果和响应体：Swagger文档会描述API的输出结果，包括返回的数据结构和字段。对于不同的HTTP状态码，还会描述相应的响应体结构。
- 错误码和错误信息：Swagger文档会列出API可能返回的错误码和对应的错误信息，方便开发者理解和处理错误情况。
Swashbuckle可以与腾讯云的API网关服务结合使用，以便更好地管理和发布API。腾讯云的API网关服务可以提供API的访问控制、流量控制、监控和日志等功能，详情请参考腾讯云API网关产品介绍：https://cloud.tencent.com/product/apigateway
相关·内容
在我的.NET Core2.0WebAPI启动期间，我通过MapRoute()方法注册到我的控制器的路由。我希望swagger能够识别这些路由，或者允许我在启动时添加它们。我知道文档表明swagger不支持传统的开箱即用的路由(只支持基于属性的路由)，但是除了为启动期
浏览 16提问于2018-02-18得票数 3
回答已采纳
如何配置swashbuckle以使用Aspnet API验证？ vc.Version("v2", "Swashbuckle Dummy API V2");}
public staticapi字符串“api/v{版本}/users”，我<
浏览 11提问于2017-06-06得票数 8
回答已采纳
2回答
我正在寻找一种简单的方法来返回Web API中所有请求到给定路由的404错误，以及该路由中的所有端点。在我的场景中，我将有一个配置标志来打开和关闭它。它是一个使用Swagger/Swashbuckle的文档端点，并希望能够将其作为一种功能切换打开或关闭。<add key="EnableDocumentation" value="true|false" /
浏览 4提问于2014-07-14得票数 0
RequestFormat = WebMessageFormat.Json,bool Test();
我需要从哪里或如何开始向我的项目中添加Swagger，这样外部开发人员就可以看到我的API上的文档了？我使用的是.NET 4.5.2和C#
浏览 3提问于2015-09-18得票数 0
回答已采纳
1回答
我正在使用Swashbuckle (一个围绕着swagger的.NET包装器)。当我生成我的swagger文档时，它从控制器名称/参数生成文档中的URI，而不是在应用程序启动时在config中定义它们。但是，Swagger文档指出端点是/DeliveryStatus。有什么可以用来确保Swagger使用配置中使用的路由，而不是
浏览 5提问于2016-06-22得票数 4
我在我的带有基本身份验证的.NET Web API中使用Swashbakle5.3版本(根据这个)。现在，当我尝试更新Swashbuckle 5.6版本时，它抛出了错误'Key is not found‘。问题出在下面的代码片段中。在路由映射期间，它无法从路由集合中找到'swagger_ui‘。我尝试了其他不同的路由值(如'swagger‘，'/swagger
浏览 0提问于2017-09-27得票数 0
我需要帮助覆盖swagger生成器来处理API端点，并将查询参数记录在swashbuckle中。
POST /api/customer?f={f}&l={l} (路由模板-> &#
浏览 2提问于2019-01-11得票数 0
我正在使用带有Swashbuckle的，Swashbuckle使用启动配置为每个版本生成一个定义文件：{ {
c.SwaggerEndpoint($"/swagger/{description.GroupName}
浏览 3提问于2020-09-16得票数 1
我从Swashbuckle开始，我用Swashbuckle在.NET核心中创建了一个Web。我需要在IIS站点的子应用程序中部署我的API。IIS基础设施
http://ip:80/myApi/swaggerservices.AddSwaggerGen(c =>
浏览 2提问于2018-08-21得票数 4
回答已采纳
我已经使用API4.5创建了一个WebAPI，并希望使用来记录此.Net。我已经在我的.Net项目中添加了。./ swagger - UI /index.html时，它成功地以swagger UI格式打开了 (json)。我看到和正在做类似的事情，
浏览 6提问于2014-01-24得票数 18
在API或Classic ASP.NET中，我们可以使用Swashbuckle生成漂亮的ASP.NET文档，包括用于直接从您的路由、控制器和模型探索和测试操作的UI。 我有不同的用例。我已经有了swagger .json文件(2.0版)。我希望将该文件加载到Swashbuckle中，Swashbuckle是否可以将Swagger UI HTML作为字符串返回？一旦我获得了字符串，我将在下一行过程中<
浏览 6提问于2019-01-17得票数 0
我有一个运行webapi (XML4.5)的帮助页面，通过ApiExplorer加载我所有的.net注释。我现在想通过swashbuckle添加swagger。所以我安装了swashbuckle，但是当我浏览到我的端点时，我得到了一个错误，正如swashbuckle文档所建议的那样。终结点: localhost:1234/api/company/swagger错误：{“
浏览 1提问于2014-07-25得票数 1
我想用相同的路由名称(相同的参数)调用不同版本的服务...[Route("api/v{version:apiVersion}/[controller]/")]
[ApiControllerActions require unique method/path combination for Swagger 2.0.(String documentName, String host, String
浏览 16提问于2020-06-16得票数 0
2回答
基于模块的多API端点
、、、、
我正在使用带有.NET核心和角度2项目模板的ASP.NET样板v2.0.1。我有一个基于单个模块生成代理的需求，因此，我考虑使用API版本控制来实现。/{documentName}/swa
浏览 4提问于2018-04-02得票数 1
我正在尝试让dotnet 6天气API示例生成静态swagger.json或swagger.yaml。我很确定我已经遵循了Microsoft文档中的步骤，但是没有生成静态文件，我希望它们出现在构建中。Microsoft docs url：
var builder = WebApplication.CreateBuilder(args);
app.
浏览 4提问于2022-06-16得票数 1
回答已采纳
我在WebApi 5中有一个.Net项目，并且已经在使用Swagger与默认设置( ConfigureServices方法中的services.AddSwaggerGen()& app.UseSwagger现在我决定通过Swashbuckle.AspNetCore.Cli创建Swagger文件。此外，还检查它是否通过dotnet swagger tofile --help工作，而且确实如此。现在，当我想通过dotnet <em
浏览 12提问于2022-01-05得票数 2
我有以下行动
config.EnableUnqualifiedNameCall(true);
POST /odata/POST({individualId})/S
浏览 3提问于2016-12-28得票数 0
我试图通过Swagger & Swashbuckle使用XML注释为我的Web项目生成API文档。在一个动作上使用ActionName属性似乎破坏了这条线上的某些东西。该操作包含在生成的XML中，并显示在Swagger中，但是当我单击它时没有细节(摘要、param等)。我不确定这是.NET、Swagger还是Swashbuckle的问题。我尝试过使用和不使用ActionName属性，它似乎对
浏览 5提问于2014-11-07得票数 0
回答已采纳
4回答
我正在Visual 2015上创建一个Azure应用程序。当我点击、浏览和重定向到http://localhost:3012/时，如果我将swagger添加到url，什么都不会发生：http://localhost:3012/swagger
似乎我需要为一个完整的地址添加/docs/v1：http://localhost:3012/swagger/docs/v1。当我添加&#x
浏览 19提问于2016-03-30得票数 6
回答已采纳
1回答
因此，我从这里创建研讨会应用程序：我已经开始在ASP.Net Core3.0应用中配置虚张声势了。UI本身是有效的，但是
我无法访问我在控制器中定义的路由，也无法在URL中获取它们，因为尽管路由是在https://localhost:5001/swagger/v1/swagger.json中定义的，例如，我无法访问：https://localhost:5001/ap
浏览 2提问于2019-11-17得票数 1
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
对象存储
实时音视频
即时通信 IM活动推荐
腾讯云开发者
