.NET Core Api使用配置Swagger

1、项目下载NuGet包

Swashbuckle.AspNetCore.Swagger: 一些模型实体定义
Swashbuckle.AspNetCore.SwaggerGen: Swagger生成器
Swashbuckle.AspNetCore.SwaggerUI:Swagger UI工具

2、配置相关信息
2.1 在配置文件Startup中配置:

ConfigureServices:

public void ConfigureServices(IServiceCollection services)
        {
            services.AddControllers();
            //设置跨域Cores
            services.AddCors(option => option.AddPolicy("cors", 
                c => c.AllowAnyOrigin().AllowAnyHeader().AllowAnyMethod()));
            //配置swagger
            services.AddSwaggerGen(c => {
                c.SwaggerDoc("v1", new Microsoft.OpenApi.Models.OpenApiInfo { Title = "SHI_NOTE", Version = "v1" });

                var xmlfile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
                var xmlpath = Path.Combine(AppContext.BaseDirectory, xmlfile);
                c.IncludeXmlComments(xmlpath);

            }
            );
        }

Configure:

 app.UseSwagger();
            app.UseSwaggerUI(
                c => c.SwaggerEndpoint("/swagger/v1/swagger.json", "SHI_NOTE")
                );
2.2 在配置Properties中launchSettings.json进行修改初始接口显示(把launchUrl的改为"swagger/index.html"):
  "profiles": {
    "IIS Express": {
      "commandName": "IISExpress",
      "launchBrowser": true,
      "launchUrl": "swagger/index.html",
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Development"
      }
    },
2.3 自动生成xml文件

自动生成

这里可以运行接口看一下效果,应该会显示成这样:
接口显示
我的项目已上传github(https://github.com/Shiqing0602/.NetCore-WEBAPI-EFCore-SqlServer.)有需要的朋友可以自行观看。

  • 1
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值