How to export swagger.json (or yaml)

by

The URL of the API definiton is displayed in the top bar of Swagger UI – in your example it’s

/v2/api-docs?group=full-petstore-api

So the full URL appears to be

http://localhost:8080/v2/api-docs?group=full-petstore-api

In newer versions of Swagger UI, the link to the API definition is often displayed below the API title, so you can right-click the link and Save As.

Link to API definition in Swagger UI 3.x

If your Swagger UI does not have a visible link to the API definition, view the page source and look for the url parameter, such as:

const ui = SwaggerUIBundle({
  url: "https://petstore.swagger.io/v2/swagger.json",     // <-------
  dom_id: '#swagger-ui',

If you don’t see the url or if url is a code expression, open the browser dev tools, switch to the Network tab and disable caching. Then refresh the page and search for the API definition file (swagger.json, swagger.yaml, api-docs or similar) among HTTP requests. You can filter by XHR to narrow down the list.

Finding the Swagger file on the Network tab of browser dev tools

Another way to find the actual url is to use the browser console and evaluate one of the following values, depending on your UI version:

  • Swagger UI 3.x:

    ui.getConfigs().url

  • Swagger UI 2.x:

    swaggerUi.api.url

Sometimes the OpenAPI definition may be embedded within a .js file – in this case take this file and strip out the extra parts.

OpenAPI definition embedded in a JavaScript file

More Related Contents:

  1. Use object type query param in swagger documentation
  2. Swagger: wildcard path parameters
  3. Swagger API which is having query string
  4. Combining defintions in Swagger docs
  5. Swagger: How to have a property reference a model in OpenAPI 2.0 (i.e. nest the models)?
  6. How to specify if a field is optional or required in OpenAPI/Swagger?
  7. How to return an array of objects in SwaggerHub?
  8. Swagger Inheritance and Composition
  9. Web Api How to add a Header parameter for all API in Swagger
  10. How to document dynamic query parameter names in OpenAPI (Swagger)?
  11. How to define a mixed-type array (with different element types) in OpenAPI 2.0?
  12. How can I represent ‘Authorization: Bearer ‘ in a Swagger Spec (swagger.json)
  13. How to define a property that can be string or null in OpenAPI (Swagger)?
  14. Swagger schema properties ignored when using $ref – why?
  15. How to define mutually exclusive query parameters in Swagger (OpenAPI)?
  16. Swagger 2.0: Multiple Path objects with different paths but same request and response
  17. Swagger/OpenAPI – use $ref to pass a reusable defined parameter
  18. How to define an optional parameter in path using swagger
  19. Added Springfox Swagger-UI and it’s not working, what am I missing?
  20. How to configure Spring Security to allow Swagger URL to be accessed without authentication
  21. Re-using model with different required properties
  22. How to write OpenAPI 3 (Swagger) specification for property name in `map` object?
  23. How not to copy-paste 3 generic error responses in almost all paths?
  24. How to define global parameters in OpenAPI?
  25. swagger-ui returns 500 after deployment
  26. How to change Swagger-ui URL prefix?
  27. Schema object without a type attribute in Swagger 2.0
  28. Swagger UI passing authentication token to API call in header
  29. Swagger: take one or more values from enum
  30. FastAPI’s RedirectResponse doesn’t work as expected in Swagger UI

Leave a Comment