集成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文件,更改自己的配置。
3. 启用项目
右键项目-在文件资源管理器中打开文件夹,来到项目的根目录,直接cmd,
最后输入命令生成,服务就启动起来了。
dotnet run
4. 另外一种启动方式
直接运行,生成后的dll文件,但是必须来的debug包下面。
dotnet XXXXXX.dll