Swagger简单实例

Posted 2020-12-05 mirzhai

随着技术的不断发展，网站框架也开始向：前后端分离的形态发展，而且前端技术和后端技术在各自的道路上越走越远。而web api 接口成了前后端唯一的联系。所以web api会变得越来越重要。

那么什么是Web Api呢？

主要有两点   1.可以对接各种客户端（浏览器，移动设备）

　　　　　　2.构建http服务的框架。

而我们今天要学的Swagger是一款可以让你更好的开发api的框架。

关于 Swagger

Swagger能成为最受欢迎的REST APIs文档生成工具之一，有以下几个原因：

• Swagger 可以生成一个具有互动性的API控制台，开发者可以用来快速学习和尝试API。
• Swagger 可以生成客户端SDK代码用于各种不同的平台上的实现。
• Swagger 文件可以在许多不同的平台上从代码注释中自动生成。
• Swagger 有一个强大的社区，里面有许多强悍的贡献者。

Swagger实战

1.创建WebApi项目：直接新建项目》ASP.NET Web应用程序》Web Api。就可以创一个web api模板，直接运行，查看api接口。我们可以从下图看出默认的api管理不是很方便，而且看起来丑爆了。

2.接下来就是使用Swagger，首先是安装Swagger，打开管理Nuget程序包，搜索swashbuckle，选中安装即可。

3.安装成功后，选中项目后右键属性》生成》勾选输出.XML文档文件，然后保存。运行项目就会生成文件binSwagger.Web.Api.xml。（这一步很重要）

4.接下来配置App_Start文件夹里SwaggerConfig.cs文件，如下图所示；

public class SwaggerConfig
    {
        public static void Register()
        {
            var thisAssembly = typeof(SwaggerConfig).Assembly;

            GlobalConfiguration.Configuration
                .EnableSwagger(c =>
                    {
                        c.SingleApiVersion("v1", "Swagger.Web.Api");

                        c.IncludeXmlComments(GetXmlCommentsPath());
                        
                    })
                .EnableSwaggerUi(c =>
                    {
                        c.DocumentTitle("My Swagger UI");
                    });
        }
        /// <summary>
        /// 获取xml文件
        /// </summary>
        /// <returns></returns>
        protected static string GetXmlCommentsPath()
        {
            return System.String.Format(@"{0}inSwagger.Web.Api.xml", System.AppDomain.CurrentDomain.BaseDirectory);
        }
    }

SwaggerConfig

5.还有要修改默认打开路径，设置为直接打开swagger。

 6.运行项目，完美显示接口。详细用法，自己摸索就行了，没有什么难度。