-
Notifications
You must be signed in to change notification settings - Fork 31
add the open api execute command #110
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -44,3 +44,18 @@ Please note the following guidelines: | |
|
||
- OpenAPI Generator can't generate Python client with Java 17+ | ||
- https://github.com/OpenAPITools/openapi-generator/issues/13684 | ||
|
||
## Usage | ||
|
||
You can launch the Swagger UI to browse the OpenAPI specs locally using Docker. | ||
First, make sure you have `docker-compose.yml` in this directory. Then run: | ||
|
||
```sh | ||
docker-compose up | ||
``` | ||
|
||
By default, the Swagger UI will be available at: [http://localhost:8080](http://localhost:8080) | ||
|
||
### Using Docker Command | ||
|
||
Alternatively, you can use the following Docker command: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
version: '3.8' | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. In Docker Compose V2, it is obsolete. |
||
services: | ||
swagger-ui: | ||
image: swaggerapi/swagger-ui:latest | ||
container_name: line-open-api-doc | ||
ports: | ||
- "8080:8080" | ||
environment: | ||
- PORT=8080 | ||
- API_URL=/openapi/messaging-api.yml | ||
volumes: | ||
- ./:/usr/share/nginx/html/openapi | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nits: Please add a line break at the end of the file. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's use Docker Compose V2.