Skip to content

Allow the local execution and customization of the swagger services using docker-compose

License

Notifications You must be signed in to change notification settings

yucer/swagger-compose

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 

Repository files navigation

Unofficial docker compose for swagger images

The aim of this project is to allow the local execution and customization of swagger services using docker-compose

Services

So far it allows to run two swagger services in localhost:

  1. Swagger online editor using its official docker image

  2. Swagger online code generator using its official doker image

The online editor allows the manual modifications of the specs and also makes direct requests to the online generator.

Local generation

But if the generation must be local, because of privacy restrictions you can...

Run services

You can run the services this way:

```bash
docker-compose up
```

in case of some modification to the config files you might need:

```bash
docker-compose down
docker-compose build
docker-compose up
```

If you want to locally build the code generator image

  1. Clone the swagger-codegen tool
git clone https://github.com/swagger-api/swagger-codegen
cd swagger-codegen
  1. Build the generator:
./run-in-docker.sh mvn clean
./run-in-docker.sh mvn package
  1. Build the online-generator:
cd modules/swagger-generator
docker build -t swaggerapi/swagger-generator .

About

Allow the local execution and customization of the swagger services using docker-compose

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published