.net6集成SwaggerAPI

最新推荐文章于 2024-12-06 13:24:09 发布

我不许人间见白头

最新推荐文章于 2024-12-06 13:24:09 发布

阅读量322

点赞数 8

文章标签： .net java struts

本文链接：https://blog.csdn.net/wukongaixuexi/article/details/142682778

版权

集成Swagger

1. 创建项目
2. 修改Program主程序
3. 启用项目
4. 另外一种启动方式

1. 创建项目

选用.net Web API创建项目
在这里插入图片描述

2. 修改Program主程序

解决中文乱码

 //解决中文乱码
builder.Services.AddControllers()
    .AddJsonOptions(options =>
    {
        options.JsonSerializerOptions.Encoder = JavaScriptEncoder.Create
        (UnicodeRanges.All);
    });

在这里插入图片描述
2. 添加注释

 builder.Services.AddSwaggerGen(c =>
 {
     c.SwaggerDoc("v1", new OpenApiInfo
     {
         Title = "客户端服务",
         Version = "V1.0",
         Description = "集成边缘侧工业物联网客户端服务WebAPI接口文档"
     });
     var file = Path.Combine(AppContext.BaseDirectory, "OcelotService01.xml"); // xml文档绝对路径
     var path = Path.Combine(AppContext.BaseDirectory, file); // xml文档绝对路径
     c.IncludeXmlComments(path, true); // true : 显示控制器层注释
     c.OrderActionsBy(o => o.RelativePath); // 对action的名称进行排序，如果有多个，就可以看见效果了。
 });

在这里插入图片描述
3. 勾选输出文件
右键项目-属性-生成-输出

4. 消除警告
右键项目-属性-生成-错误和警告，添加1591
5. 修改访问路径
找到launchsettings.json文件，更改自己的配置。