码迷,mamicode.com
首页 > Windows程序 > 详细

.NET CORE API Swagger

时间:2018-09-03 19:33:20      阅读:292      评论:0      收藏:0      [点我收藏+]

标签:oid   var   etc   spn   bin   name   comm   ati   inf   

  新建一个core api  项目,使用nuget搜索Swashbuckle.AspNetCore   安装

技术分享图片

 修改项目生成属性

技术分享图片

修改启动Startup

 public void ConfigureServices(IServiceCollection services)
        {
            services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_1);

            #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 = "core-test", Email = "1165220871@qq.com", Url = "" }
                });
                var basePath = Microsoft.DotNet.PlatformAbstractions.ApplicationEnvironment.ApplicationBasePath;
                var xmlPath = Path.Combine(basePath, "core-test.xml");//这个就是上面图片中xml文件名
                c.IncludeXmlComments(xmlPath, true);//默认的第二个参数是false,这个是controller的注释,记得修改
            });
            #endregion

        }

 

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

现在默认启动的路径是http://localhost:60442/api/values,需要修改一下launchSettings.json文件

技术分享图片

然后直接启动项目

   技术分享图片

 

.NET CORE API Swagger

标签:oid   var   etc   spn   bin   name   comm   ati   inf   

原文地址:https://www.cnblogs.com/li-lun/p/9579982.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!