Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ohbarye/swagger-merger-docker
This is an unofficial Docker image for https://github.com/WindomZ/swagger-merger.
https://github.com/ohbarye/swagger-merger-docker
docker docker-compose openapi swagger
Last synced: about 1 month ago
JSON representation
This is an unofficial Docker image for https://github.com/WindomZ/swagger-merger.
- Host: GitHub
- URL: https://github.com/ohbarye/swagger-merger-docker
- Owner: ohbarye
- Created: 2021-12-08T07:11:54.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-31T15:23:21.000Z (6 months ago)
- Last Synced: 2024-05-31T17:14:32.624Z (6 months ago)
- Topics: docker, docker-compose, openapi, swagger
- Language: Dockerfile
- Homepage: https://hub.docker.com/r/ohbarye/swagger-merger
- Size: 5.86 KB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# swagger-merger Docker
This is an unofficial Docker image for https://github.com/WindomZ/swagger-merger.
## Usage
Let's say you have target files under `/docs`.
Run the command below to generate a merged YAML file.
```shell
docker run --rm -v $PWD/docs:/swagger --entrypoint swagger-merger ohbarye/swagger-merger '-c -i /swagger/src.yaml -o /swagger/dist.yaml'
```
### watch mode
The following command enables _watch_ mode. It automatically generates YAML file everywhen you edit any source files.
```shell
docker run --rm -v $PWD/docs:/swagger --entrypoint watch ohbarye/swagger-merger 'swagger-merger -c -i /swagger/src.yaml -o /swagger/dist.yaml' /swagger/
```
```
> Watching /swagger/
```
## Development
Edit Dockerfile, then build it.
```shell
docker build -t ohbarye/swagger-merger .
```
Test that the built image works well with commands in usage section.
## Release
Tag the built image.
```shell
docker tag ohbarye/swagger-merger ohbarye/swagger-merger:0.1.0
```
```shell
docker tag ohbarye/swagger-merger ohbarye/swagger-merger:latest
```
Push to the registory.
```shell
docker image push --all-tags ohbarye/swagger-merger
```
Check https://hub.docker.com/r/ohbarye/swagger-merger.