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

  • 时间:
  • 浏览:1

前言

前后分离的好处,就是 后端埋头做业务逻辑功能,不还要太久考虑用户体验,只专注于数据、性能开发,对于前端还要的数据还都可以 通过组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日志