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

  • 时间:
  • 浏览:0
  • 来源:大发快3_快3app平台_大发快3app平台

前言

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