在文件API方法分组 - 有一些自定义属性 [英] Grouping of API methods in documentation - is there some custom attribute

问题描述

我有一样的控制器。

 公共类UserController的：ApiController
{
  [路线（API /用户）]
  IHttpActionResult的getUser（）{...}
}公共类ResumeController：ApiController
{
  [路线（API /用户/恢复）]
  IHttpActionResult GetResumes（）{...}
}
 

这对喜欢招摇产生输出

有没有一种方法（除了通过推出覆盖缺省实现自己的 ISwaggerProvider 或合并两个控制器为一个）执行组的名称？类似

 公共类UserController的：ApiController
{
  [路线（API /用户）]
  [MagicalAttributeName（组=用户）]
  IHttpActionResult的getUser（）{...}
}公共类ResumeController：ApiController
{
  [路线（API /用户/恢复）]
  [MagicalAttributeName（组=用户）]
  IHttpActionResult GetResumes（）{...}
}
 

解决方案

有一个办法 - 虽然没有什么神奇的属性 - 你可以改变招摇启动配置以介绍你自己的自定义属性分组的默认规则。

  GlobalConfiguration.Configuration
 .EnableSwagger（C =＆GT; {
   c.GroupActionsBy（apiDesc =＆GT; apiDesc
     .GetControllerAndActionAttributes＆LT; MethodGroupAttribute＆GT;（）任何（）？
        apiDesc.GetControllerAndActionAttributes＆LT; MethodGroupAttribute（）
        。首先（）组名：
        apiDesc.ActionDescriptor.ControllerDescriptor.ControllerName）;
 }）;
///＆LT;总结＆gt;
///强制法规定的组内显示，无论控制器
///＆LT; /总结＆gt;
[AttributeUsage（AttributeTargets.Method，的AllowMultiple = FALSE）]
公共类MethodGroupAttribute：属性
{
    ///＆LT;总结＆gt;
    ///组名
    ///＆LT; /总结＆gt;
    公共字符串组名{获得;私人集; }    ///＆LT;总结＆gt;
    ///构造函数
    ///＆LT; /总结＆gt;
    ///＆LT; PARAM NAME =组名＆GT;＆LT; /参数＆GT;
    公共MethodGroupAttribute（串组名）
    {
        如果（string.IsNullOrEmpty（组名））
        {
            抛出新的ArgumentNullException（组名）;
        }
        组名=组名;
    }
}
 

用法：

  [路线（API /用户）]
[MethodGroup（用户）]
IHttpActionResult的getUser（）{...}
 

I have controller like

public class UserController : ApiController
{
  [Route("api/user")]
  IHttpActionResult GetUser() { ... }
}

public class ResumeController : ApiController
{
  [Route("api/user/resumes")]
  IHttpActionResult GetResumes() { ... }
}

Which on swagger generates output like

Is there a way (besides overriding default implementation by rolling out your own ISwaggerProvider or merging two controllers into one) to enforce the group name ? Something like

public class UserController : ApiController
{
  [Route("api/user")]
  [MagicalAttributeName(Group="User")]
  IHttpActionResult GetUser() { ... }
}

public class ResumeController : ApiController
{
  [Route("api/user/resumes")]
  [MagicalAttributeName(Group="User")]
  IHttpActionResult GetResumes() { ... }
}

解决方案

There is a way - although there is no magic attribute - you can change default rules of grouping in swagger startup configuration in order to introduce your very own custom attribute.

GlobalConfiguration.Configuration 
 .EnableSwagger(c => {
   c.GroupActionsBy(apiDesc => apiDesc
     .GetControllerAndActionAttributes<MethodGroupAttribute>().Any() ?
        apiDesc.GetControllerAndActionAttributes<MethodGroupAttribute()
        .First().GroupName :
        apiDesc.ActionDescriptor.ControllerDescriptor.ControllerName);
 });


/// <summary>
/// Forces method to be displayed within specified group, regardless of controller
/// </summary>
[AttributeUsage(AttributeTargets.Method, AllowMultiple = false)]
public class MethodGroupAttribute : Attribute
{
    /// <summary>
    /// Group name
    /// </summary>
    public string GroupName { get; private set; }

    /// <summary>
    /// ctor
    /// </summary>
    /// <param name="groupName"></param>
    public MethodGroupAttribute(string groupName)
    {
        if (string.IsNullOrEmpty(groupName))
        {
            throw new ArgumentNullException("groupName");
        }
        GroupName = groupName;
    }
}

Usage:

[Route("api/user")]
[MethodGroup("User")]
IHttpActionResult GetUser() { ... }

这篇关于在文件API方法分组 - 有一些自定义属性的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！