ASP.NET Core WebApi使用Swagger生成api说明文档

2021-10-12 01:13:29

1. Swagger是什么？

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。Swagger 让部署管理和使用功能强大的API从未如此简单。

2.Swagger可以干什么？

a.接口，服务可视化，非常清晰，好用

b.做接口测试，方便测试人员使用

Github：https://github.com/wuyabusi/swagger.git

第一步：创建WebApi工程

第二步：引入swagger的包

第三步：打开解决方案属性-->生成，勾选XML文档文件，保存

第四步：在Startup.cs的ConfigureServices方法中添加配置

   public void ConfigureServices(IServiceCollection services)

        {

            //配置跨域处理

            services.AddCors(options =>

            {

                options.AddPolicy("any", builder =>

                {

                    builder.AllowAnyOrigin() //允许任何来源的主机访问

                    .AllowAnyMethod()

                    .AllowAnyHeader()

                    .AllowCredentials();//指定处理cookie

                });

            });

            //配置Swagger

            services.AddSwaggerGen(c =>

            {

                c.SwaggerDoc("v1", new Info

                {

                    Version = "v1",

                    Title = "接口文档",

                    Description = "RESTful API for TwBusManagement"

                });

                var basePath = PlatformServices.Default.Application.ApplicationBasePath;

                var xmlPath = Path.Combine(basePath, "TextApi.xml");//和上面图片中xml地址相同

                c.IncludeXmlComments(xmlPath);

                //

            });

            services.AddMvc();

        }

第五步.在Startup.cs的Configure方法中添加配置, 启用中间件为生成的 JSON 文档和 Swagger UI 提供服务：

 public void Configure(IApplicationBuilder app, IHostingEnvironment env)

        {

            if (env.IsDevelopment())

            {

                app.UseDeveloperExceptionPage();

            }

            app.UseStaticFiles(); //静态文件服务

            app.UseSwagger();

            app.UseSwaggerUI(c =>

            {

                c.SwaggerEndpoint("/swagger/v1/swagger.json", "TwBusManagement API V1");

                //c.ShowExtensions();

            });

            app.UseMvc();

        }

第六步.在Properties下的launchSettings.json的文件中修改初始页面

然后运行就可以

如有问题，欢迎指正

点击应用下面的连接,可以导航到 http://localhost:<port>/swagger/v1/swagger.json生成的描述终结点的文档显示如下json格式。

参考出处:https://www.cnblogs.com/wuyabaibsd/p/9413994.html

=================================================================================================

Swagger的高级用法（自定义以及扩展）

使用Swagger为API文档增加说明信息

在 AddSwaggerGen 方法的进行如下的配置操作会添加诸如作者、许可证和说明信息等：

//注册Swagger生成器，定义一个和多个Swagger 文档

services.AddSwaggerGen(c =>

{

    c.SwaggerDoc("v1", new Info

    {

        Version = "v1",

        Title = "yilezhu's API",

        Description = "A simple example ASP.NET Core Web API",

        TermsOfService = "None",

        Contact = new Contact

        {

            Name = "依乐祝",

            Email = string.Empty,

            Url = "http://www.cnblogs.com/yilezhu/"

        },

        License = new License

        {

            Name = "许可证名字",

            Url = "http://www.cnblogs.com/yilezhu/"

        }

    });

});

wagger UI 显示版本的信息如下图所示：

为了防止博客被转载后，不保留本文的链接，特意在此加入本文的链接：https://www.cnblogs.com/yilezhu/p/9241261.html

为接口方法添加注释

大家先点击下api，展开如下图所示，可以没有注释啊，怎么来添加注释呢？

按照下图所示用三个/添加文档注释，如下所示

/// <summary>

/// 这是一个api方法的注释

/// </summary>

/// <returns></returns>

[HttpGet]

public ActionResult<IEnumerable<string>> Get()

{

     return new string[] { "value1", "value2" };

}

然后运行项目，回到swaggerUI中去查看注释是否出现了呢

还是没有出现，别急，往下看！

启用XML 注释

可使用以下方法启用 XML 注释：

右键单击“解决方案资源管理器”中的项目，然后选择“属性”
查看“生成”选项卡的“输出”部分下的“XML 文档文件”框

启用 XML 注释后会为未记录的公共类型和成员提供调试信息。如果出现很多警告信息例如，以下消息指示违反警告代码 1591：

warning CS1591: Missing XML comment for publicly visible type or member 'TodoController.GetAll()'

如果你有强迫症，想取消警告怎么办呢？可以按照下图所示进行取消

注意上面生成的xml文档文件的路径，

注意：

1.对于 Linux 或非 Windows 操作系统，文件名和路径区分大小写。例如，“SwaggerDemo.xml”文件在 Windows 上有效，但在 CentOS 上无效。

2.获取应用程序路径，建议采用Path.GetDirectoryName(typeof(Program).Assembly.Location)这种方式或者·AppContext.BaseDirectory这样来获取

//注册Swagger生成器，定义一个和多个Swagger 文档

            services.AddSwaggerGen(c =>

            {

                c.SwaggerDoc("v1", new Info

                {

                    Version = "v1",

                    Title = "yilezhu's API",

                    Description = "A simple example ASP.NET Core Web API",

                    TermsOfService = "None",

                    Contact = new Contact

                    {

                        Name = "依乐祝",

                        Email = string.Empty,

                        Url = "http://www.cnblogs.com/yilezhu/"

                    },

                    License = new License

                    {

                        Name = "许可证名字",

                        Url = "http://www.cnblogs.com/yilezhu/"

                    }

                });

                // 为 Swagger JSON and UI设置xml文档注释路径

                var basePath = Path.GetDirectoryName(typeof(Program).Assembly.Location);//获取应用程序所在目录（绝对，不受工作目录影响，建议采用此方法获取路径）

                var xmlPath = Path.Combine(basePath, "SwaggerDemo.xml");

                c.IncludeXmlComments(xmlPath);

            });

重新生成并运行项目查看一下注释出现了没有

通过上面的操作可以总结出，Swagger UI 显示上述注释代码的 <summary> 元素的内部文本作为api大的注释！

当然你还可以将 remarks 元素添加到 Get 操作方法文档。它可以补充 <summary> 元素中指定的信息，并提供更可靠的 Swagger UI。 <remarks> 元素内容可包含文本、JSON 或 XML。代码如下：

 /// <summary>

 /// 这是一个带参数的get请求

 /// </summary>

 /// <remarks>

 /// 例子:

 /// Get api/Values/1

 /// </remarks>

 /// <param name="id">主键</param>

 /// <returns>测试字符串</returns>

 [HttpGet("{id}")]

 public ActionResult<string> Get(int id)

 {

       return $"你请求的 id 是 {id}";

 }

重新生成下项目，当好到SwaggerUI看到如下所示：

描述响应类型

摘录自：https://www.cnblogs.com/yanbigfeg/p/9232844.html

接口使用者最关心的就是接口的返回内容和响应类型啦。下面展示一下201和400状态码的一个简单例子：

我们需要在我们的方法上添加：[ProducesResponseType(201)][ProducesResponseType(400)]

然后添加相应的状态说明：返回value字符串如果id为空

最终代码应该是这个样子：

 /// <summary>

 /// 这是一个带参数的get请求

 /// </summary>

 /// <remarks>

 /// 例子:

 /// Get api/Values/1

 /// </remarks>

 /// <param name="id">主键</param>

 /// <returns>测试字符串</returns>

 /// <response code="201">返回value字符串</response>

/// <response code="400">如果id为空</response>

 // GET api/values/2

[HttpGet("{id}")]

[ProducesResponseType(201)]

[ProducesResponseType(400)]

public ActionResult<string> Get(int id)

{

     return $"你请求的 id 是 {id}";

}

效果如下所示

使用SwaggerUI测试api接口

下面我们通过一个小例子通过SwaggerUI调试下接口吧

点击一个需要测试的API接口，然后点击Parameters左右边的“Try it out ” 按钮
在出现的参数文本框中输入参数，如下图所示的，输入参数2
点击执行按钮，会出现下面所示的格式化后的Response，如下图所示

好了，今天的在ASP.NET Core WebApi使用Swagger生成api说明文档看这篇就够了的教程就到这里了。希望能够对大家学习在ASP.NET Core中使用Swagger生成api文档有所帮助！

总结

本文从手工书写api文档的痛处说起，进而引出Swagger这款自动生成api说明文档的工具！然后通过通俗易懂的文字结合图片为大家演示了如何在一个ASP.NET Core WebApi中使用SwaggerUI生成api说明文档。最后又为大家介绍了一些ASP.NET Core 中Swagger的一些高级用法！希望对大家在ASP.NET Core中使用Swagger有所帮助！

参考出处:http://www.cnblogs.com/yilezhu/p/9241261.html

后续会更新生成客户端代码的使用和说明.

码农公寓