CODEWITHSUNDEEP
asp.net-mvc-5asp.net-web-api2swashbuckleswashbuckle.examples
Alexei - check Codidact
Alexei - check Codidact

Reputation: 23088

SwaggerRequestExample attribute does not work in ASP.NET MVC 5 (.NET Framework 4.5.2)

I am toying with Swashbuckle.Examples package (3.10.0) in an ASP.NET MVC project. However, I cannot make request examples appear within the UI.

Configuration (SwaggerConfig.cs)

public static void Register()
{
    var thisAssembly = typeof(SwaggerConfig).Assembly;

    GlobalConfiguration.Configuration
        .EnableSwagger(c => {
             c.SingleApiVersion("v1", "TestApp.Web");
             c.IncludeXmlComments(string.Format(@"{0}\bin\TestApp.Web.xml", System.AppDomain.CurrentDomain.BaseDirectory));
             c.OperationFilter<ExamplesOperationFilter>();
             c.OperationFilter<DescriptionOperationFilter>();
             c.OperationFilter<AppendAuthorizeToSummaryOperationFilter>();
                })
            .EnableSwaggerUi(c => { });
 }

Request example classes

public class EchoRequestExample : IExamplesProvider
{
    public object GetExamples()
    {
        return new EchoInput { Value = 7 } ;
    }
}

public class EchoInput
{
    public int Value { get; set; }
}

Action

[HttpGet]
[Route("Echo")]
[CustomApiAuthorize]
[SwaggerRequestExample(typeof(EchoInput), typeof(EchoRequestExample))]
[ResponseType(typeof(EchoServiceModel))]
public HttpResponseMessage Echo([FromUri] EchoInput model)
{
    var ret = new EchoServiceModel
    {
        Username = RequestContext.Principal.Identity.Name,
        Value = value
    };
    return Request.CreateResponse(HttpStatusCode.OK, ret);
}

Swagger UI shows xml comments and output metadata (model and an example containing default values), but shows no request example. I attached to process and EchoRequestExample.GetExamples is not hit.

Question: How to make SwaggerRequestExample attribute work in ASP.NET MVC 5?

Note: Windows identity is used for authorization.

Upvotes: 3

Views: 9341

Answers (2)

Alexei - check Codidact
Alexei - check Codidact

Reputation: 23088

I received an answer from library owner here:

Swagger request examples can only set on [HttpPost] actions

It is not clear if this is a design choice or just a limitation, as I find [HttpGet] examples also relevant.

Upvotes: 1

Helder Sepulveda
Helder Sepulveda

Reputation: 17614

I know the feeling, lot's of overhead just for an example, I struggle with this for a while, so I created my own fork of swashbuckle, and after unsuccessful attempts to merge my ideas I ended up detaching and renaming my project and pushed to nuget, here it is: Swagger-Net

An example like that will be:

    [SwaggerExample("id", "123456")]
    public IHttpActionResult GetById(int id)
    {

Here the full code for that: Swagger_Test/Controllers/IHttpActionResultController.cs#L26

Wondering how that looks like on the Swagger-UI, here it is:
http://swagger-net-test.azurewebsites.net/swagger/ui/index?filter=IHttpActionResult#/IHttpActionResult/IHttpActionResult_GetById

Upvotes: 0

Related Questions