netcore3.0 webapi集成Swagger 5.0,Swagger使用
2024-09-20 10:48:12
Swagger使用
1、描述
Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。
作用:
1.接口的文档在线自动生成。
2.功能测试
本文转自:https://www.cnblogs.com/datacool/p/11805585.html
今天来尝尝鲜。貌似.net core 3.0使用Swagger 4.0.1会报错,随手一搜,还没人写这个把调试通过的代码贴一下:
依赖包:
using Microsoft.AspNetCore.Builder; using Microsoft.AspNetCore.Hosting; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.Hosting; using Microsoft.OpenApi.Models; using System; using System.IO; using System.Reflection; namespace WebApplication4 { public class Startup { public Startup(IConfiguration configuration) { Configuration = configuration; } public IConfiguration Configuration { get; } // This method gets called by the runtime. Use this method to add services to the container. public void ConfigureServices(IServiceCollection services) { services.AddControllers(); services.AddSwaggerGen(c => { c.SwaggerDoc("v1", new OpenApiInfo { Title = ".Net Core中间件API文档", Version = "v1" }); // 为 Swagger 设置xml文档注释路径 var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml"; var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile); c.IncludeXmlComments(xmlPath); }); } // This method gets called by the runtime. Use this method to configure the HTTP request pipeline. public void Configure(IApplicationBuilder app, IWebHostEnvironment env) { //启用中间件服务生成Swagger app.UseSwagger(); //启用中间件服务生成SwaggerUI,指定Swagger JSON终结点 app.UseSwaggerUI(c => { c.SwaggerEndpoint("/swagger/v1/swagger.json", ".Net Core中间件API文档 V1"); c.RoutePrefix = string.Empty;//设置根节点访问 }); if (env.IsDevelopment()) { app.UseDeveloperExceptionPage(); } app.UseRouting(); app.UseAuthorization(); app.UseEndpoints(endpoints => { endpoints.MapControllers(); }); } } }
控制器:
using System; using System.Collections.Generic; using System.Linq; using System.Threading.Tasks; using Microsoft.AspNetCore.Mvc; using Microsoft.Extensions.Logging; namespace WebApplication4.Controllers { /// <summary> /// 天气预报API /// </summary> [ApiController] [Route("api/[controller]/[action]")] public class WeatherForecastController : ControllerBase { private static readonly string[] Summaries = new[] { "Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching" }; private readonly ILogger<WeatherForecastController> _logger; public WeatherForecastController(ILogger<WeatherForecastController> logger) { _logger = logger; } /// <summary> /// 获取当前天气 /// </summary> /// <param name="size">城市的个数</param> /// <returns></returns> [HttpGet] [HttpPost] ") { var rng = new Random(); , Convert.ToInt32(size)).Select(index => new WeatherForecast { Date = DateTime.Now.AddDays(index), TemperatureC = rng.Next(-, ), Summary = Summaries[rng.Next(Summaries.Length)] }) .ToArray(); } /// <summary> /// 测试方法 /// </summary> /// <returns></returns> [HttpGet] public ApiResult Demo() { return new ApiResult { Message = "操作成功!", Success = true, Result = }; } } }
最新文章
- codevs 1013 求先序排列(二叉树遍历)
- Unlink of file &#39;.git/objects/pack/pack-***.pack&#39; failed. Should I try again? (y/n) (转)
- [翻译]用神经网络做回归(Using Neural Networks With Regression)
- 你应当如何学习C++(以及编程)(转载)
- HDU2243 考研路茫茫——单词情结(AC自动机+矩阵快速幂)
- vim下正则表达式的非贪婪匹配
- [CF676C]Vasya and String(尺取法,原题)
- HTML获取用户输入的几种玩法
- Android的AndroidManifest.xml文件的详解
- [转]ActiveMQ 即时通讯服务 浅析
- Win10 UWP开发系列:开发一个自定义控件——带数字徽章的AppBarButton
- 【1】mac下面iTerm配置oh-my-zsh教程
- Centos + docker,Ubuntu + docker介绍安装及详细使用
- javascript 作用域详解
- Android开发之ListView设置隔行变色
- Java“毒丸”使用示例,实现取消任务
- ADF_Starting系列3_使用ADF开发富Web应用程序之开发User Interface
- java常用类总结
- js 的垃圾回收器 原理 坑 优化-- 待续
- 【转】DWM 窗体玻璃效果实现