swagger-editor 4.14.0 → 4.14.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -121,13 +121,14 @@ To help with the migration, here are the currently known issues with 3.X. This l
|
|
|
121
121
|
## Docker
|
|
122
122
|
|
|
123
123
|
### Running the image from DockerHub
|
|
124
|
-
|
|
124
|
+
|
|
125
|
+
There is a docker image published in **docker.swagger.io** registry.
|
|
125
126
|
|
|
126
127
|
To use this, run the following:
|
|
127
128
|
|
|
128
129
|
```
|
|
129
|
-
docker pull swaggerapi/swagger-editor
|
|
130
|
-
docker run -d -p 80:8080 swaggerapi/swagger-editor
|
|
130
|
+
docker pull docker.swagger.io/swaggerapi/swagger-editor
|
|
131
|
+
docker run -d -p 80:8080 docker.swagger.io/swaggerapi/swagger-editor
|
|
131
132
|
```
|
|
132
133
|
|
|
133
134
|
This will run Swagger Editor (in detached mode) on port 80 on your machine, so you can open it by navigating to `http://localhost` in your browser.
|
|
@@ -135,13 +136,13 @@ This will run Swagger Editor (in detached mode) on port 80 on your machine, so y
|
|
|
135
136
|
* You can provide a URL pointing to an API definition (may not be available if some security policies such as CSP or CORS are enforced):
|
|
136
137
|
|
|
137
138
|
```
|
|
138
|
-
docker run -d -p 80:8080 -e URL="https://petstore3.swagger.io/api/v3/openapi.json" swaggerapi/swagger-editor
|
|
139
|
+
docker run -d -p 80:8080 -e URL="https://petstore3.swagger.io/api/v3/openapi.json" docker.swagger.io/swaggerapi/swagger-editor
|
|
139
140
|
```
|
|
140
141
|
|
|
141
142
|
* You can provide your own `json` or `yaml` definition file from your local host:
|
|
142
143
|
|
|
143
144
|
```
|
|
144
|
-
docker run -d -p 80:8080 -v $(pwd):/tmp -e SWAGGER_FILE=/tmp/swagger.json swaggerapi/swagger-editor
|
|
145
|
+
docker run -d -p 80:8080 -v $(pwd):/tmp -e SWAGGER_FILE=/tmp/swagger.json docker.swagger.io/swaggerapi/swagger-editor
|
|
145
146
|
```
|
|
146
147
|
|
|
147
148
|
**Note:** When both `URL` and `SWAGGER_FILE` environment variables are set, `URL` has priority and `SWAGGER_FILE` is ignored.
|
|
@@ -149,19 +150,19 @@ docker run -d -p 80:8080 -v $(pwd):/tmp -e SWAGGER_FILE=/tmp/swagger.json swagge
|
|
|
149
150
|
* You can specify a different base url via `BASE_URL` variable for accessing the application - for example if you want the application to be available at `http://localhost/swagger-editor/`:
|
|
150
151
|
|
|
151
152
|
```
|
|
152
|
-
docker run -d -p 80:8080 -e BASE_URL=/swagger-editor swaggerapi/swagger-editor
|
|
153
|
+
docker run -d -p 80:8080 -e BASE_URL=/swagger-editor docker.swagger.io/swaggerapi/swagger-editor
|
|
153
154
|
```
|
|
154
155
|
|
|
155
156
|
* You can specify a different port via `PORT` variable for accessing the application, default is `8080`.
|
|
156
157
|
|
|
157
158
|
```
|
|
158
|
-
docker run -d -p 80:80 -e PORT=80 swaggerapi/swagger-editor
|
|
159
|
+
docker run -d -p 80:80 -e PORT=80 docker.swagger.io/swaggerapi/swagger-editor
|
|
159
160
|
```
|
|
160
161
|
|
|
161
162
|
* You can specify Google Tag Manager ID via `GTM` variable for tracking the usage of the swagger-editor.
|
|
162
163
|
|
|
163
164
|
```
|
|
164
|
-
docker run -d -p 80:8080 -e GTM=GTM-XXXXXX swaggerapi/swagger-editor
|
|
165
|
+
docker run -d -p 80:8080 -e GTM=GTM-XXXXXX docker.swagger.io/swaggerapi/swagger-editor
|
|
165
166
|
```
|
|
166
167
|
|
|
167
168
|
You can also customize the different endpoints used by the Swagger Editor with the following environment variables. For instance, this can be useful if you have your own Swagger generator server:
|