一、添加NuGet包
二、注册Swagger服务
public void ConfigureServices(IServiceCollection services)
{
//services.AddRazorPages();
services.AddControllersWithViews().AddNewtonsoftJson();
#region 注册Swagger服务
services.AddSwaggerGen(s =>
{
#region 注册 Swagger
s.SwaggerDoc("V1", new OpenApiInfo()
{
Title = "测试",
Version = "version-01",
Description = "SwaggerApi"
});
#endregion
});
#endregion
}
三、使用Swagger中间件
四、示例
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Logging;
namespace NET5MicroService.Areas.Api.Controllers
{
[Route("api/[controller]")]
[ApiController]
public class TestSwaggerController : ControllerBase
{
private readonly ILogger<TestSwaggerController> _logger;
public TestSwaggerController(ILogger<TestSwaggerController> logger)
{
_logger = logger;
_logger.LogInformation($"{nameof(TestSwaggerController)} 控制器被实例化~~");
}
[HttpGet]
[Route("GetString")]
public string GetString()
{
_logger.LogInformation("GetString 被调用");
return "获取字符串成功!";
}
[HttpGet]
[Route("GetInt")]
public int GetInt(int i)
{
_logger.LogInformation($"GetString 被调用,参数:{i}");
return i;
}
[HttpGet]
[Route("GetJson")]
public string GetJson(int id, string name)
{
return Newtonsoft.Json.JsonConvert.SerializeObject(new
{
Id = id,
Name = name
});
}
}
}