使用swagger服务搭建.net core api

创建.net core api

新建项目。文件——新建——项目

 

 

 

选择应用程序模板。

设置存放路径，命名方案名称。

 

 

创建api。

 

 

 

搭建成功。

 

 

 

使用swagger服务

添加引用

右键依赖项

 

 

 

搜索服务并安装。安装好之后，在nuget下会新增该包。

 

 

在startup.cs下的configureservices方法中添加服务。

 

 

public void configureservices(iservicecollection services)
        {
            services.addmvc().setcompatibilityversion(compatibilityversion.version_2_2);
            // register the swagger generator, defining 1 or more swagger documents
            services.addswaggergen(c =>
            {
                c.swaggerdoc("v1", new info { title = "my api", version = "v1" });
                var xmlfile = $"{assembly.getexecutingassembly().getname().name}.xml";
                var xmlpath = path.combine(appcontext.basedirectory, xmlfile);
                // c.includexmlcomments(xmlpath);
            });
        }

 

在startup.cs类下的configure方法中使用服务。

 

public void configure(iapplicationbuilder app, ihostingenvironment env)
        {
            if (env.isdevelopment())
            {
                app.usedeveloperexceptionpage();
            }
            else
            {
                // the default hsts value is 30 days. you may want to change this for production scenarios, see https://aka.ms/aspnetcore-hsts.
                app.usehsts();
            }
            app.useswagger();
            //启用中间件服务对swagger-ui，指定swagger json终结点
            app.useswaggerui(c =>
            {
                c.swaggerendpoint("/swagger/v1/swagger.json", "my api v1");
            });
            app.usehttpsredirection();
            app.usemvc();
        }

 

最后修改properties文件夹下的launchsettings.json文件

 

 

运行成功。