Generate WebAPI documentation in swagger json format

Question

I have created a WebAPI using .Net 4.5 and want to document this API using Swagger. I have added swagger-ui in my .Net project. Now when i browse to ../swagger-ui/index.html it successfully opens pet store api-docs (json) in swagger UI format.

My question is how can I create such (swagger) json for my WebAPI controllers and models? As I have put in required XML summaries/comments to c# classes and attributes.

I saw that Swagger.Net and Swashbuckle are there doing similar things but I could not really understand how to generate swagger-json file using any of them. There might be very small mistake I am doing but unable to point out.

Please help.

I want to do opposite to this stackoverflow.com/questions/10560857/… — theGeekster
– theGeekster, Commented Jan 24, 2014 at 15:35
Did you find any solution to the question? I'm also interesting in generation of json spec without running a web server. — Shrike
– Shrike, Commented Nov 14, 2014 at 12:06
No, I couldn't find any solution yet, which supports WebAPI's Attribute Routing. — theGeekster
– theGeekster, Commented Nov 20, 2014 at 8:21
For a .NET 5++ project using Swashbuckle.AspNetCore, you can find the OpenAPI .json file in <my project>\obj\Debug\net8.0\EndpointInfo — paulsm4
– paulsm4, Commented Nov 20 at 22:05

Matt Frear · Accepted Answer · 2017-09-12 19:55:21Z

27

As stated, /swagger takes you to the swagger UI.

If you're using Swashbuckle, then /swagger/docs/v1 should take you to the swagger.json file - I found this using Chrome Dev tools.

Edit: if you're using Swashbuckle.AspNetCore, then the url is slightly different - /swagger/v1/swagger.json

edited Sep 12, 2017 at 19:55

answered Apr 16, 2015 at 14:25

Matt Frear

55.3k12 gold badges83 silver badges92 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

Peter Marshall Over a year ago

Thats if you are using Swashbuckle.

Todd Smith · Accepted Answer · 2014-02-11 18:41:21Z

4

You need to integrate Swagger.NET into your project so that you end up with the following controller:

public class SwaggerController : ApiController { /* snip */ }

and you should also have the following route registered:

context.Routes.MapHttpRoute (
name : "Swagger",
routeTemplate: "api/swagger"
defaults: new
{
  controller = "Swagger",
  action = "Get",
});

assuming that is working you should be able to call /api/swagger and get something like the following:

{
  apiVersion: "4.0.0.0",
  swaggerVersion: "2.0",
  basePath: "http://localhost:5555",
  resourcePath: null,
  apis: [
  {
    path: "/api/docs/Values",
    description: "No Documentation Found.",
    operations: [ ]
  },
  {
    path: "/api/docs/Home",
    description: "No Documentation Found.",
    operations: [ ]
  }
]

}

then in SwaggerUI/index.html you'll want to update the discoveryUrl:

<script type="text/javascript">
    $(function () {
        window.swaggerUi = new SwaggerUi({
            discoveryUrl: "http://localhost:5555/api/swagger",
            apiKey:"",
            dom_id:"swagger-ui-container",
            supportHeaderParams: false,
            supportedSubmitMethods: ['get', 'post', 'put']
        });

        window.swaggerUi.load();
    });
</script>

answered Feb 11, 2014 at 18:41

Todd Smith

17.3k11 gold badges63 silver badges82 bronze badges

3 Comments

Shrike Over a year ago

That's again runtime version of doc. We have to run a web server to get/show doc. But the question was about how to generate a json spec. I'm also interested in this topic - I need to generate a json Swagger spec file on build.

Todd Smith Over a year ago

Swagger.Net will generate the json spec for you using the ASP.NET ApiExplorer. If you need to save the json spec file for some reason then just call the url and save the results to a file.

Sébastien Ros - MSFT Over a year ago

Some data will always be available only at runtime, this is why you need to run the service. For instance the routes will be defined by code, so a static analysis would not be able to guess the actual routes without running the service.

velmurugan · Accepted Answer · 2017-09-14 12:14:55Z

1

You can use "NSwagStudio" desktop application to load the json document without running the api project. By providing the api assembly.

https://github.com/RSuter/NSwag/wiki/NSwagStudio

Download the (NSwagStudio) windows desktop application.

answered Sep 14, 2017 at 12:14

velmurugan

191 silver badge3 bronze badges

Collectives™ on Stack Overflow

Generate WebAPI documentation in swagger json format

3 Answers 3

1 Comment

3 Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

1 Comment

3 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related