bwin老品牌:碧桂园(02007.HK)4月合同销售额按年微升至226.9亿人民币

2、准备分组枚举

/// <summary>
/// 接口分组枚举
/// </summary>
public enum ApiGroupNames
{
    [GroupInfo(Title = "登录认证", Description = "登录相关接口", Version = "v1")]
    Login,
    [GroupInfo(Title = "User", Description = "用户相关接口")]
    User,
    [GroupInfo(Title = "User", Description = "订单相关接口")]
    Order
}

3、准备接口特性

/// <summary>
/// 分组接口特性
/// </summary>
public class ApiGroupAttribute : Attribute, IApiDescriptionGroupNameProvider
{
    /// <summary>
    /// 
    /// </summary>
    /// <param name="name"></param>
    public ApiGroupAttribute(ApiGroupNames name)
    {
        GroupName = name.ToString();
    }
    /// <summary>
    /// 分组名称
    /// </summary>
    public string GroupName { get; set; }
}

4、给不同接口加上特性

[ApiController]
public class HomeController : ControllerBase
{
   private readonly ILogger<HomeController> _logger;
   public HomeController(ILogger<HomeController> logger)
    {
        _logger = logger;
    }
    /// <summary>
    /// 获取用户信息
    /// </summary>
    /// <returns></returns>
    [HttpGet("home/getuser")]
    [ApiGroup(ApiGroupNames.User)]
    public string GetUser()
    {
        return "my name is dotnetboy";
    }
    /// <summary>
    /// 登录成功
    /// </summary>
    /// <returns></returns>
    [HttpPost("home/login")]
    [ApiGroup(ApiGroupNames.Login)]
    public string Login()
    {
        return "login success";
    }
    /// <summary>
    /// 删除订单
    /// </summary>
    [HttpDelete("home/{id}")]
    [ApiGroup(ApiGroupNames.Order)]
    public string DeleteOrder(string id)
    {
        return $"delete success,id={id}";
    }
    /// <summary>
    /// 留言
    /// </summary>
    [HttpDelete("home/message")]
    public string DeleteUser(string msg)
    {
        return $"message：{msg}";
    }
}

5、修改 ConfigureServices 方法的 AddSwaggerGen

services.AddSwaggerGen(options =>
{
    options.SwaggerDoc("v1", new OpenApiInfo
    {
        Title = "接口文档",
        Version = "v1",
        Description = "测试 webapi"
    });
	// 遍历ApiGroupNames所有枚举值生成接口文档，Skip(1)是因为Enum第一个FieldInfo是内置的一个Int值
	typeof(ApiGroupNames).GetFields().Skip(1).ToList().ForEach(f =>
	{
        //获取枚举值上的特性
        var info = f.GetCustomAttributes(typeof(GroupInfoAttribute), false).OfType<GroupInfoAttribute>().FirstOrDefault();
        options.SwaggerDoc(f.Name, new OpenApiInfo
        {
            Title = info?.Title,
            Version = info?.Version,
            Description = info?.Description
        });
	});
    // 没有特性的接口分到NoGroup上
    options.SwaggerDoc("NoGroup", new OpenApiInfo
    {
    	Title = "无分组"
    });
    // 判断接口归于哪个分组
    options.DocInclusionPredicate((docName, apiDescription) =>
    {
    	if (docName == "NoGroup")
    	{
            // 当分组为NoGroup时，只要没加特性的接口都属于这个组
            return string.IsNullOrEmpty(apiDescription.GroupName);
    	}
    	else
    	{
    		return apiDescription.GroupName == docName;
    	}
    });
});

6、修改 Configure 方法的 UseSwaggerUI

app.UseSwaggerUI(options =>
{
    // 遍历ApiGroupNames所有枚举值生成接口文档
    typeof(ApiGroupNames).GetFields().Skip(1).ToList().ForEach(f =>
    {
        //获取枚举值上的特性
        var info = f.GetCustomAttributes(typeof(GroupInfoAttribute), false).OfType<GroupInfoAttribute>().FirstOrDefault();
        options.SwaggerEndpoint($"/swagger/{f.Name}/swagger.json", info != null ? info.Title : f.Name);
    });
    options.SwaggerEndpoint("/swagger/NoGroup/swagger.json", "无分组");
    options.RoutePrefix = string.Empty;
});

休息会再看