net core Webapi基础工程搭建(三)——在线接口文档Swagger

  • 时间:
  • 浏览:2

前言

前后分离的好处,我希望后端埋头做业务逻辑功能,无需可不能否 过多考虑用户体验,只专注于数据、性能开发,对于前端不可不能否 的数据可不能否 通过组Json将会这些依据回调,我希望前后两端不可不能否 选者好接口Api的规范,我希望前端将会不可不能否 查看接口的相关信息,就不可不能否 文档的支撑了。没有 问题来了,后端在开发过程中每次改动接口,都不可不能否 改动文档,累不累。

Swagger

Swagger作为一有另4个 在线文档,通以前端的接口控制器生成一套Json串数据,实时展示后端的接口请求地址,参数,类型以及回调,很好的处里这些问题(后端可不能否 给前端一有另4个 Swagger的地址,我希望来句你自己看吧,当然还是不可不能否 多沟通的),这些在Java里用过以前,就马上看看有没有 .net的版本,甜得,语言不会相通的,废话过多说,结束了了英语 第三方类库的引用

NuGet引用第三方类库

工具->NuGet包管理器->管理处里方案的NuGet应用程序池池包...

浏览中查找"Swashbuckle.AspNetCore",选者项目工程,点击安装。



引入完成后,在Startup.cs文件ConfigureServices中,加入以下代码:

        public void ConfigureServices(IServiceCollection services)
        {
            services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);
            
           #region Swagger
            services.AddSwaggerGen(options =>
            {
                options.SwaggerDoc("v1", new Info
                {
                    Version = "v1.1.0",
                    Title = "April WebAPI",
                    Description = "后台框架",
                    TermsOfService = "None",
                    Contact = new Contact { Name = "Blank", Email = "1829027193@qq.com", Url = "http://www.aprilblank.com" }
                });
            });
            #endregion 
        }

在Startup.cs类里编辑Configure依据,加入以下代码:

        public void Configure(IApplicationBuilder app, IHostingEnvironment env)
        {
           …
           
            #region Swagger
            app.UseSwagger();
            app.UseSwaggerUI(options =>
            {
                options.SwaggerEndpoint("/swagger/v1/swagger.json", "ApiHelp V1");
            });
            #endregion

            app.UseHttpsRedirection();
            app.UseMvc();
        }

重新生成工程后,访真不知道的端口/swagger就可不能否 看后接口文档帮助界面了。

别急,还有

在线的接口文档是有了,可一有另4个 接口啥意思都真不知道,前端还是得一脸懵逼真不知道,这些接口啥意思啊,这些参数啥意思啊那些的。

没错,注释

还是在Startup.cs文件ConfigureServices中,加入以下代码:

        public void ConfigureServices(IServiceCollection services)
        {
            services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);
            #region Swagger
            services.AddSwaggerGen(options =>
            {
                options.SwaggerDoc("v1", new Info
                {
                    Version = "v1.1.0",
                    Title = "April WebAPI",
                    Description = "后台框架",
                    TermsOfService = "None",
                    Contact = new Contact { Name = "Blank", Email = "790048789@qq.com", Url = "http://www.aprilblank.com" }
                });
                
                // 为 Swagger JSON and UI设置xml文档注释路径
                var basePath = Path.GetDirectoryName(AppContext.BaseDirectory);//获取应用应用程序池池所在目录(绝对,不受工作目录影响,建议采用此依据获取路径)
                var xmlPath = Path.Combine(basePath, "April.xml");
                options.IncludeXmlComments(xmlPath);
                
            });
            #endregion
        }

右键WebApi这些项目工程,点击属性,在生成这些栏

先拿Values这些控制器做实验



重新生成不会在对应目录看后有Apirl.xml文档文件,运行以前查看/Swagger



点开刚才单独注释参数的/api/Values/{id}

小结

一有另4个 WebApi工程离不开文档,而一有另4个 在线文档可不能否 省掉自己这些事,我希望Swagger也支持在线调试,虽说我自己还是倾向于Postman(后续会介绍相关工具),这些在线文档不仅是方便了前端查看,总之在开发上我觉得是一有另4个 利器。

下一篇,介绍后台核心之一,Log日志