Use the spec url parameter of the swagger online editor

[pask84]

Q&A (please complete the following information)

• OS: Windows 10
• Browser: chrome
• Version: 84.0.4147.105
• Method of installation: online use
• Swagger-Editor version: https://editor.swagger.io
• Swagger/OpenAPI version: OpenAPI 3.0

Content & configuration

Example Swagger/OpenAPI definition:

{
  "openapi": "3.0.0",
  "info": {
    "version": "1.0.0",
    "title": "Swagger"
  },
  "paths": {
    "/mypath": {
      "get": {
        "operationId": "listPets",
        "parameters": [
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A paged array of pets"
          }
        }
      }
    }
  }
}

Swagger-Editor configuration options:

https://editor.swagger.io/?spec={...}

Describe the bug you're encountering

I'm trying to pass the spec parameter in the url to the swagger editor to be able to open the API spec passed in the URL

https://editor.swagger.io/?spec={...}

as documented here:

https://swagger.io/docs/open-source-tools/swagger-ui/usage/configuration/

spec SPEC Object={}. A JavaScript object describing the OpenAPI definition. When used, the url parameter will not be parsed. This is useful for testing manually-generated definitions without hosting them.

but it seems that doesn't work, here the example

below the spec put in the link:

{
  "openapi": "3.0.0",
  "info": {
    "version": "1.0.0",
    "title": "Swagger"
  },
  "paths": {
    "/mypath": {
      "get": {
        "operationId": "listPets",
        "parameters": [
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A paged array of pets"
          }
        }
      }
    }
  }
}

To reproduce...

Steps to reproduce the behavior:

1. Click on the link

Expected behavior

the swagger online editor should open the specification passed in the spec query parameter

Screenshots

Additional context or thoughts

[maximehamm]

Hello
An idea when this will be fixed ?
Thanx !

[danielschilling-ml]

The documentation you referenced is for Swagger UI, but then you passed the spec parameter to Swagger Editor instead.

Swagger Editor does have a query string parameter for loading a spec from a url, documented here: https://github.com/swagger-api/swagger-editor/blob/master/docs/import.md. If you are able to specify a URL instead of a JSON object, this might work for you:

https://editor.swagger.io/?url=YOUR_URL_HERE