.Net core swagger

越来越多的企业开始将系统进行前后端分离改造，分离就需要使用webapi。

在创建webapi时使用swagger，在前端可以清楚的看到接口及接口描述。

Swagger也称为Open API，Swagger从API文档中手动完成工作，并提供一系列用于生成，可视化和维护API文档的解决方案。简单的说就是一款让你更好的书写API文档的框架。

如何使用？

第一步：创建webapi ，命令dotnet new webapi，然后nuget添加swagger包，Swashbuckle.AspNetCore   

vscode 下命令添加 dotnet "add" "e:\xxxxx\webapiswagger.csproj" "package" "Swashbuckle.AspNetCore" "-v" "1.1.0"

第二步：添加using Swashbuckle.AspNetCore.Swagger;

　　　　在Startup.cs 文件中的ConfigureServices方法中注册swaggerGen方法，可以添加其他的属性，许可证，描述，服务条款等等

            services.AddSwaggerGen(c=>
            {
                c.SwaggerDoc("v6", new OpenApiInfo
                {
                    Version = "v6",
                    Title = "swagertitle"
                });

            });

第三步：注册完成后，那就是使用了，上面的版本与下面的版本号相同

            app.UseSwagger();
            app.UseSwaggerUI(c =>
            {
                c.SwaggerEndpoint("/swagger/v6/swagger.json", "MyAPIV6");
            });

第四步：启动即可，访问http://localhost:<port>/swagger/v6/swagger.json

如果需要在接口上添加相应的描述？

第一步：在项目属性-》生成-》勾选xml文档文件

第二步：在接口上方///即可添加描述

第三步：在ConfigureServices方法的AddSwaggerGen方法中

xml的地址和名称，xmlFile是xml的名称

                var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
                options.IncludeXmlComments(xmlPath);

 

注：在访问的时候需要访问swagger页面，则在属性中去修改local