SwaggerResponseExample is not working in version 2.2.0

[thaynaracsantos]

To work I had to downgrade to version 2.1.1

[mattfrear]

It's working for me. Can you try 2.2.1, which I just released a minute ago? If it's not working please post your code.

[thaynaracsantos]

I tested and it's not working in version 2.2.1 too. I am using .net core 2.0 and bogus nuget, but even without bogus it's still not working in these versions (2.2.0/2.2.1).

My repository https://github.com/ThaynaraSantos/api-doc

[mattfrear]

Hmm I don't have .NET Core 2.0 installed on my dev box as it has issues with some of my existing .NET Core 1.1 solutions at work. I will try run your code under Core 1.1 and see if I can reproduce your issue.

[thaynaracsantos]

Great, thanks!

[mattfrear]

What exactly is not working? I've moved your code to my Core 1.1 sample app:

        [HttpGet]
        [Produces("application/json")]
        [SwaggerResponse((int)HttpStatusCode.OK, Type = typeof(IEnumerable<House>))]
        [SwaggerResponseExample((int)HttpStatusCode.OK, typeof(HouseGetExamples))]
        public IEnumerable<House> Get()
        ...

    public class HouseGetExamples : IExamplesProvider
    {
        public object GetExamples()
        {
            HouseGetExample houseGetExample = new HouseGetExample();

            return new List<House>()
            {
                houseGetExample.GetExamples() as House,
                houseGetExample.GetExamples() as House
            };
        }
    }

    public class HouseGetExample : IExamplesProvider
    {
        public object GetExamples()
        {
            House house = new House {Address = "456 Bridge Street", Color = "Blue", Id = 1};
            return house;
        }
    }

And as you can see, it's working fine:

[thaynaracsantos]

Run the project and go to http://localhost:25111/docs

The same response example, in version 2.1.1, is working.

[mattfrear]

I have reluctantly installed .NET 2.0 SDK on my dev machine just to try reproduce your issue.

I ran your repo - it works fine for me locally. Your repo was using 2.1.1 of my package. I updated your repo to use the latest version of my package - 2.2.1, and it still works fine.

I am testing this by going to /swagger:

I didn't know about the /docs page until you told me about it - what generates that? Is that part of Swashbuckle.AspNetCore? Ah, I see, it's a Redoc page. I've never heard of that. Anyway, that's working fine for me here too:

Hmm. I can't fix it for you if I can't reproduce it.

[thaynaracsantos]

swagger.json generated in:

Version 2.1.1 (working)

Version 2.2.1 (not_working)

Maybe, the ReDoc script can't read the example in swagger.json after that change.

---

For your knowledge. (https://github.com/Rebilly/ReDoc)

[mattfrear]

OK, so it IS working in Swagger-UI, which is where I test it, but not working in ReDoc.

I removed the application/json stuff by request as part of Issue #12.
There is a PR on my .NET Framework version of this project to optionally add it back in again mattfrear/Swashbuckle.Examples#13

When I get a chance to do that I will port that PR to this project and then it should work again for ReDoc.

I have no idea why redoc needs application/json to work and that seems stupid, but I haven't been through their spec to make sense of it, as I only just heard of them.

[RomanHotsiy]

ReDoc author here.
Just to clarify, ReDoc behaves correctly here according to Swagger 2.0 spec: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#exampleObject
Example object should be a map from {mime type} to example. So, technically, the output produced by 2.2.1 is invalid Swagger.

[mattfrear]

Thanks @RomanGotsiy for clarifying. I will revert the change so that my package produces valid Swagger as soon as I get a chance.

[mattfrear]

Released https://www.nuget.org/packages/Swashbuckle.AspNetCore.Examples/2.2.2

[thaynaracsantos]

Thank you! It's working fine now.

[mattfrear]

This seems to be fixed now with Swashbuckle 3.0