从壹开始前后端分离【 .NET Core2.0 Api + Vue 2.0 + AOP + 分布式】框架之三 || Swagger的使用 3.1

WHY

上文中已经说到，单纯的项目接口在前后端开发人员使用是特别不舒服的，那所有要推荐一个，既方便又美观的接口文档说明框架，当当当，就是Swagger，随着互联网技术的发展，现在的网站架构基本都由原来的后端渲染，变成了：前端渲染、后端分离的形态，而且前端技术和后端技术在各自的道路上越走越远。

前端和后端的唯一联系，变成了API接口；API文档变成了前后端开发人员联系的纽带，变得越来越重要，swagger就是一款让你更好的书写API文档的框架。

没有API文档工具之前，大家都是手写API文档的，在什么地方书写的都有，有在confluence上写的，有在对应的项目目录下readme.md上写的，每个公司都有每个公司的玩法，无所谓好坏。

书写API文档的工具有很多，但是能称之为“框架”的，估计也只有swagger了。

HOW

下面开始引入swagger插件

方法有两个：

1）可以去swagger官网或github上下载源码，然后将源码（一个类库）引入自己的项目；

2）直接利用NuGet包添加程序集应用（这里就是前边说的 在以后的开发中，Nuget无处不在）。

右键项目中的 Dependencies -- > Manage Nuget Packags --> Browse --> Search "Swashbuckle.AspNetCore" --> Install

然后就在项目的Nuget依赖里看到刚刚引入的Swagger

图 2

这个时候，你可以试一下，当然是不可以的，还记得上文说的，.Net Core 都需要一个程序入口么，对就是Startup.cs文件

打开Startup.cs类，编辑ConfigureServices类

    public void ConfigureServices(IServiceCollection services)

        {

            services.AddMvc();

            #region Swagger

            services.AddSwaggerGen(c =>

            {

                c.SwaggerDoc("v1", new Info

                {

                    Version = "v0.1.0",

                    Title = "Blog.Core API",

                    Description = "框架说明文档",

                    TermsOfService = "None",

                    Contact = new Swashbuckle.AspNetCore.Swagger.Contact { Name = "Blog.Core", Email = "[email protected]", Url = "https://www.jianshu.com/u/94102b59cc2a" }

                });

            });

            #endregion

        }

编辑Configure类

public void Configure(IApplicationBuilder app, IHostingEnvironment env)

        {

            if (env.IsDevelopment())

            {

                app.UseDeveloperExceptionPage();

            }

            app.UseMvc();

            #region Swagger

            app.UseSwagger();

            app.UseSwaggerUI(c =>

            {

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

            });

            #endregion

        }

到这，已经完成swagger的添加，F5 运行调试，在域名后面输入/swagger，点击回车，当当当 出来啦

图 3

图 4

既美观又快捷，这样以后发布出去，前后端开发人员就可以一起开发了，嗯！不错！

WHAT

好啦，本节基本就是这里了，你简单浏览后，会了解到，什么是Swagger，它如何创建使用，如何运行的，但是，细心的你会发现一些问题

NEXT

如何直接F5运行，首页无法加载？

接口虽有，但是却没有文字文档说明？

对于接口是如何加权限验证的？

如何发布到服务器，大家一起接口开发呢？

项目开发中的实体类是如何在Swagger中展示的？

让我们带着这些问题，继续浏览下一篇吧，Swagger 3.2 配置

CODE

https://github.com/anjoy8/Blog.Core.git

QQ群：

867095512     (blod.core)