将请求模式添加到swagger描述
我正在使用.Net core 3.1，并致力于在Swagger中记录应用程序接口操作，并希望记录请求正文，以便它将显示所有细节，如数据类型，验证等最终用户。
目前，我正在对xml注释中的模式进行硬编码，如下所示：
/// <summary>
/// Order Details
/// </summary>
/// <remarks>
/// Parameter's description:
///
/// {
/// "productName": string, -- Required
/// "isUsed: true,
/// "orderDate": "2021-02-19T08:43:10.300Z", -- Required
/// "discountDate": "2021-02-19T08:43:10.300Z"
/// }
/// </remarks>
/// <returns>Returns Order results</returns>
/// <response code="200">Order Placed</response>
[HttpPost]
[Route("Place Order")]
public ActionResult<OrderPlacingResult> PlaceOrder(OrderPlaceParam orderPlaceParam)
{
///
}这给出了预期的结果，并且对于较小的请求体是可行的。但是，如果请求包含许多参数，则不建议在description部分中对其进行硬编码。
有没有人能建议一种更好的方法来记录参数，这样它就可以给出它在模式中提供的所有细节。
请注意，请求没有实际参数，我想记录请求正文。
回答 2
Stack Overflow用户
发布于 2022-01-31 08:37:43
请求/响应模型本身不应该在方法/函数的备注部分中描述参数本身(应用summary标签)。稍后可以在swagger文档中找到它。请检查下面的所有截图，看看它是如何工作的。
附言:我附上了截图，而不是故意从生产的代码类，对不起。
Stack Overflow用户
发布于 2021-02-19 19:44:05
Swagger使用api摘要生成文档，如果您不编写这些摘要，那么您就没有文档。但您可以避免用代码编写所有描述，并创建swagger json并告诉swagger使用此文件。当您在启动中添加这一行时：
public void ConfigureServices(IServiceCollection services)
{
services.AddSwaggerGen(options =>
{
//set options
});
}
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
app.UseSwagger();
app.UseSwaggerUI(c =>
{
c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
c.RoutePrefix = "docs";
c.DocumentTitle = " Api Title";
});
}您可以在http://localhost:{port}/docs中查看文档。您还可以在以下路径中看到Swagger生成的json文件：
http://localhost:{port}/swagger/v1/swagger.json
因此，您可以保存此json并编辑其中任何内容，您可以从api中删除摘要，或者只有几行代码来描述您的api，假设您将文件保存在应用程序根目录中，并应将其添加到应用程序配置中：
app.Map("/swagger/v1/savedfile.json", b =>
{
b.Run(x =>
File.ReadAllTextAsync(Path.Combine(AppContext.BaseDirectory,
"savedfile.json"))
.ContinueWith(readTask => x.Response.WriteAsync(readTask.Result))
);
}).UseSwaggerUI(c =>
{
c.SwaggerEndpoint("/swagger/v1/savedfile.json", "My API V1");
c.RoutePrefix = "docs";
c.DocumentTitle = "Api Title";
});https://stackoverflow.com/questions/66274508
复制相似问题
腾讯云开发者
Copyright © 2013 - 2026 Tencent Cloud. All Rights Reserved. 腾讯云 版权所有
深圳市腾讯计算机系统有限公司 ICP备案/许可证号：粤B2-20090059 
粤公网安备44030502008569号
腾讯云计算（北京）有限责任公司 京ICP证150476号 | 京ICP备11018762号