Swashbuckle Swagger - コンテンツタイプに注釈を付ける方法は？

Question

Swaggerメタデータが自分のリソースでサポートされているコンテンツタイプを含むように、ASP.NET WebAPIアクションに注釈を付けるにはどうすればよいですか？

具体的には、私はドキュメントが私の資源の一つは、「オリジナル」application/jsonとapplication/xmlを返すだけでなく、新しい形式、application/vnd.blah+jsonまたは+xmlを返すことができることを示したいと思います。

Answer 1

あなたがする必要があるのはこれです。 闊歩仕様： あなたはこれがOperationFilter

擬似コードの着信を行うことができます

"produces": [ 
      "application/json", 
      "text/json" 
      ], 

その操作に応答タイプのリストにあなたの応答タイプを追加する必要があります！

public class CustomResponseType : IOperationFilter 
{   
    public void Apply(Operation operation, SchemaRegistry schemaRegistry, ApiDescription apiDescription) 
    {    
      if (operation.operationId == "myCustomName") 
      { 
       operation.produces.Add("application/vnd.blah+json"); 
      }    
    }  
} 

OperationIdは[SwaggerOperation("myCustomName")]注釈を介して設定することができます。あなたが特定のルートまたは基本的には何かのためにそれを行うことができ 代わりのoperation.operationId == "myCustomName" ：

次に注意

c.OperationFilter<CustomResponseType>(); 

swaggerConfig.csでoperationsFilterを適用します。 ApiDescriptionは、文脈に関する情報をたくさん提供します。

Answer 2

あなたのような属性を設定するには、以下のコードを使用することができますコントローラのAPIメソッドでVisualBeanの答え

@拡張：

[SwaggerResponseContentType(responseType:"application/pdf", Exclusive=true)] 
public HttpResponseMessage GetAuthorityForm(string id) 
{ 
.... 

注：「真=独占」他のすべてのコンテンツの種類を削除しますが、それ以外の場合は、新しい属性を使用すると、Swagger UIドロップダウンに新しいレスポンスコンテンツタイプが追加されます。それはあなたのコントローラまたはAPIをドキュメントだけ変更することはありません。

SwaggerConfig.cs

GlobalConfiguration.Configuration 
      .EnableSwagger(c => 
// Set filter to apply Custom Content Types to operations 
// 
c.OperationFilter<ResponseContentTypeOperationFilter>(); 

SwaggerReponseContentTypeAttribute.cs

/// <summary> 
/// SwaggerResponseContentTypeAttribute 
/// </summary> 
[AttributeUsage(AttributeTargets.Method)] 
public sealed class SwaggerResponseContentTypeAttribute : Attribute 
{ 
    /// <summary> 
    /// SwaggerResponseContentTypeAttribute 
    /// </summary> 
    /// <param name="responseType"></param> 
    public SwaggerResponseContentTypeAttribute(string responseType) 
    { 
     ResponseType = responseType; 
    } 
    /// <summary> 
    /// Response Content Type 
    /// </summary> 
    public string ResponseType { get; private set; } 

    /// <summary> 
    /// Remove all other Response Content Types 
    /// </summary> 
    public bool Exclusive { get; set; } 
} 

ResponseContentTypeOperationFilter.cs

public class ResponseContentTypeOperationFilter : IOperationFilter 
{ 
    public void Apply(Operation operation, SchemaRegistry schemaRegistry, ApiDescription apiDescription) 
    { 
     var requestAttributes = apiDescription.GetControllerAndActionAttributes<SwaggerResponseContentTypeAttribute>().FirstOrDefault(); 

     if (requestAttributes != null) 
     { 
      if (requestAttributes.Exclusive) 
       operation.produces.Clear(); 

      operation.produces.Add(requestAttributes.ResponseType); 
     } 
    } 
} 

Answer 3

@ OzBobの答えは、メソッドに単一の属性だけを追加したいと仮定しています。あなたは、同じ方法で複数のコンテンツタイプを追加し、文書化したい場合は、以下を使用することができます。

SwaggerReponseContentTypeAttribute.cs

/// <summary> 
/// SwaggerResponseContentTypeAttribute 
/// </summary> 
[AttributeUsage(AttributeTargets.Method, AllowMultiple = true)] 
public class SwaggerResponseContentTypeAttribute : Attribute 
{ 
    /// <summary> 
    /// SwaggerResponseContentTypeAttribute 
    /// </summary> 
    /// <param name="responseType"></param> 
    public SwaggerResponseContentTypeAttribute(string responseType) 
    { 
     ResponseType = responseType; 
    } 
    /// <summary> 
    /// Response Content Type 
    /// </summary> 
    public string ResponseType { get; private set; } 

    /// <summary> 
    /// Remove all other Response Content Types 
    /// </summary> 
    public bool Exclusive { get; set; } 
} 

ResponseContentTypeOperationFilter。あなたは、同じ方法で複数の属性を持っていて、既存のコンテンツタイプを交換したいとき、あなただけの最初の属性にExclusive = trueを設定する必要があることをCS

public class ResponseContentTypeOperationFilter : IOperationFilter 
{ 
    public void Apply(Operation operation, SchemaRegistry schemaRegistry, ApiDescription apiDescription) 
    { 
     var requestAttributes = apiDescription.GetControllerAndActionAttributes<SwaggerResponseContentTypeAttribute>(); 

     foreach (var requestAttribute in requestAttributes) 
     { 
      if (requestAttribute.Exclusive) 
      { 
       operation.produces.Clear(); 
      } 
      operation.produces.Add(requestAttribute.ResponseType); 
     } 
    } 
} 

注意。そうしないと、すべての属性がドキュメントに反映されません。