Swashbuckle Swagger - Comment annoter des types de contenu?

Comment annoter mon ASP.NET WebAPI actions de sorte que le style de métadonnées comprend les types de contenu que mes ressources de soutien?

Plus précisément, je veux de la documentation afin de montrer que l'un de mes ressources peut retourner l'original application/json et application/xml mais également retourne maintenant un nouveau format, application/vnd.blah+json ou +xml.

Shashbuckle 5 doit prendre soin de cela pour vous si vous vous inscrivez le MediaTypeFormatter au cours de l'Api Web de configuration.
Merci. Que les sons intelligent, mais je le veux, par action/cours de route.
Je pense que vous avez juste besoin de les ajouter en tant que formateur dans votre webconfig - c'est global, bien que, sur pas par action de base. Ce que vous pourriez faire est de créer votre propre operationsFilter et il s'applique uniquement à ces opérations, qui renvoie le nouveau format

OriginalL'auteur Luke Puplett | 2016-01-25

9

Ce que vous devez faire est ceci;
Swagger spec:
vous devez ajouter votre réponse-type de la liste de réponses-types pour l'opération
```
"produces": [
            "application/json",
            "text/json"
            ],
```
Cela peut être fait avec un OperationFilter

Pseudo-Code entrant!!!
```
public class CustomResponseType : IOperationFilter
{        
    public void Apply(Operation operation, SchemaRegistry schemaRegistry, ApiDescription apiDescription)
    {            
            if (operation.operationId == "myCustomName")
            {
                operation.produces.Add("application/vnd.blah+json");
            }            
    }      
}
```
la OperationId peut être définie par la [SwaggerOperation("myCustomName")] annotation.

Puis appliquer le operationsFilter dans le swaggerConfig.cs
```
c.OperationFilter<CustomResponseType>();
```
Note:
au lieu de operation.operationId == "myCustomName"
vous pourriez le faire pour un itinéraire particulier ou quoi que ce soit d'autre en fait. ApiDescription donne BEAUCOUP d'informations sur le contexte.

OriginalL'auteur VisualBean

L'extension @VisualBean la réponse de

Sur un Contrôleur de la méthode de l'API, vous pouvez utiliser le code ci-dessous pour définir un Attribut comme:

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

Remarque: Exclusif=true' va supprimer tous les autres types de contenu, en utilisant le nouvel Attribut permettra d'ajouter un nouveau Type de Contenu dans le Style de l'INTERFACE utilisateur déroulant. Il ne modifiera PAS votre Contrôleur ou de l'API seulement la documentation.

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);
        }
    }
}

OriginalL'auteur OzBob

@OzBob réponse suppose que vous ne voulez ajouter un attribut à une méthode. Si vous souhaitez ajouter et de document de plus d'un des types de contenu pour la même méthode, vous pouvez utiliser les éléments suivants:

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.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);
        }
    }
}

Noter que lorsque vous avez plusieurs attributs sur la même méthode et que vous souhaitez remplacer les types de contenu, vous devez définir Exclusive = true sur le premier attribut. Sinon, vous n'obtiendrez pas tous les attributs dans la documentation.

Avoir à mettre de l'Exclusif=vrai que le premier attribut n'est pas évident pour le développeur. Je pense que l'ordre des attributs ne devrait pas affecter la sortie. Tri de la liste des attributs dans le filtre devrait supprimer la restriction : requestAttributes.OrderByDescending(a=>un.Exclusive)

OriginalL'auteur bjorgvin

Suivantes sur OzBob de réponse. Depuis Swashbuckle 4.0.x vous pouvez avoir besoin de mettre à jour le fonctionnement du filtre de code légèrement:

ResponseContentTypeOperationFilter.cs

using Swashbuckle.AspNetCore.Swagger;
using Swashbuckle.AspNetCore.SwaggerGen;
using System.Linq;

public class ResponseContentTypeOperationFilter : IOperationFilter
{
    public void Apply(Operation operation, OperationFilterContext context)
    {
        if (!context.ApiDescription.TryGetMethodInfo(out var methodInfo))
        {
            return;
        }
        var requestAttributes = methodInfo.GetCustomAttributes(true).OfType<SwaggerResponseContentTypeAttribute>().FirstOrDefault();

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

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

OriginalL'auteur Grubl3r

Vous devez vous connecter pour publier un commentaire.