今天來嚐嚐鮮。貌似.net core 3.0使用Swagger 4.0.1會報錯,隨手一搜,還沒人寫這個把調試經過的代碼貼一下:json
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(); }); } } }
依賴包:api
控制器:app
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] public IEnumerable<WeatherForecast> GetWeather(string size = "5") { var rng = new Random(); return Enumerable.Range(1, Convert.ToInt32(size)).Select(index => new WeatherForecast { Date = DateTime.Now.AddDays(index), TemperatureC = rng.Next(-20, 55), Summary = Summaries[rng.Next(Summaries.Length)] }) .ToArray(); } /// <summary> /// 測試方法 /// </summary> /// <returns></returns> [HttpGet] public ApiResult Demo() { return new ApiResult { Message = "操做成功!", Success = true, Result = 1 }; } } }