|
安装NuGet 程序包=》Swashbuckle.AspNetCore 在 Startup.ConfigureServices 方法里添加注册生成器 1 //注册Swagger生成器，定义一个和多个Swagger 文档 2 services.AddSwaggerGen(c => 3 { 4 c.SwaggerDoc("v1", new Info() { Title = "测试版本", Version = "v1" }); 5 6 c.ResolveConflictingActions(apiDescriptions => apiDescriptions.First()); 7 c.CustomSchemaIds(type => type.FullName); // 解决相同类名会报错的问题 8 9 c.IncludeXmlComments(Path.Combine(Directory.GetCurrentDirectory(), "SwaggerDemo.xml")); // 注释要使用的 XML 文档10 });
如果需要使用到在页面显示控制器的一些注释，可选择生成-输出-XML文档文件。 1591可免去一些没有加注释的一些警告。 注释实例：
---- 在 Startup.Configure 方法里添加中间件服务 //启用中间件服务生成Swagger作为JSON终结点app.UseSwagger();//启用中间件服务对swagger-ui，指定Swagger JSON终结点app.UseSwaggerUI(c =>{ c.SwaggerEndpoint("/swagger/v1/swagger.json", "DemoAPI V1"); }); 添加完后，可以自己建控制器了。 注意：控制器必须是API标识的控制器。
里面的方法也必须带有HTTP请求协议。
最后执行访问=》/swagger/index.html
学习来自依乐祝大佬的文章=》点击进入超时空传送 |
|
|
