simapi-net/Attributes/SimApiDocAttribute.cs

using System;
using Swashbuckle.AspNetCore.Annotations;

namespace SimApi.Attributes;

/// <summary>
/// 快捷自定义接口文档类
/// </summary>
[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class)]
public class SimApiDocAttribute : SwaggerOperationAttribute
{
    /// <summary>
    /// 定义接口说明
    /// </summary>
    /// <param name="tags">接口分组列表</param>
    /// <param name="name">接口名称</param>
    /// <param name="description">接口描述</param>
    public SimApiDocAttribute(string[] tags, string name, string? description = null)
    {
        Tags = tags;
        Summary = name;
        if (description != null)
        {
            Description = description;
        }
        // Consumes = new[] {"application/json"};
        // Produces = new[] {"application/json"};
    }

    /// <summary>
    /// 定义接口说明
    /// </summary>
    /// <param name="tag">接口分组</param>
    /// <param name="name">接口名称</param>
    /// <param name="description">接口描述</param>
    public SimApiDocAttribute(string tag, string name, string? description = null) : this([tag], name, description)
    {
    }
}