SwaggerGen()方法到底是做什么的?

l7mqbcuq  于 2023-06-05  发布在  其他
关注(0)|答案(4)|浏览(718)

我最近开始使用API,并且使用了Program.cs中的方法。
AddSwaggerGen()是什么?

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddSwaggerGen();
yqkkidmi

yqkkidmi1#

这行代码将Swagger生成器添加到服务集合中。SwaggerUI在用户友好的UI中显示项目中的REST API,以便您可以在浏览器中测试它们。要呈现这个UI,您需要JSON文件,该文件表示由Swagger Generator生成的JSON的API的详细信息[名称、输入参数、类型等]。
注:Swagger是描述REST API定义的项目的名称,自2015年以来,它一直被称为OpenAPI

8ehkhllq

8ehkhllq2#

传递给AddSwaggerGen方法的配置操作添加了作者、许可证和描述等信息。您可以找到更多信息here

brjng4g3

brjng4g33#

AddSwaggerGen()方法添加了一个为API生成Swagger文档的服务。当调用此方法时,它将服务添加到依赖注入容器,以便以后可以在应用程序中使用它。当使用该服务时,它将生成一个Swagger文档,描述可用的API及其操作。这对于使用API的开发人员可能很有用,因为它提供了有关如何使用API的详细信息。

vnzz0bqm

vnzz0bqm4#

它是Swashbuckle库的一部分,该库支持生成
OpenAPI
和Swagger文档
使用示例:

services.AddSwaggerGen(c =>
{
    c.SwaggerDoc("Your Version", new OpenApiInfo
    {
        Version = "Your Version",
        Title = "Your Title Api",
        Description = "Desc",
        TermsOfService = new Uri("https://example.com/terms"),
        Contact = new OpenApiContact
        {
            Name = "Shayne Boyer",
            Email = string.Empty,
            Url = new Uri("https://socialNet.com/<user>"),
        },
        License = new OpenApiLicense
        {
            Name = "Use under LICX",
            Url = new Uri("https://example.com/license"),
        }
    });
});

相关问题