Skip to content

Docker Compose file to generate a complete Swagger Development environment (Editor + Generator)

Notifications You must be signed in to change notification settings

spudmashmedia/swagger-complete-selfhosted

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 

Repository files navigation

Swagger Complete - Self Hosted

Docker Compose file to generate a complete Swagger Development environment (Editor + Generator) No outbound http calls to * .swagger.io

Requirements

Please install

  1. Docker Toolbox
https://www.docker.com/products/docker-toolbox
  1. Docker-Compose
https://docs.docker.com/compose/

Installation

Clone the repository

Using Kitematic (Docker toolbox), click Docker CLI to open a console which is remoted into your Virtual Box VM with Docker.

In the console, run:

  /> docker-compose -f docker-compose.yaml up -d

At this point 2 docker containers will be created:

  • swaggercompleteselfhosted_editor_1 (port 28099)
  • swaggercompleteselfhosted_codegen_1 (port 28199)

Test

Test Editor

In your Chrome web browser, navigate to

http://192.168.99.100:28099

Swagger-editor should now load.

Test Code Generator

With the editor still open, and developer network tab open, in the menu

  1. Generate Server | Aspnet5

a zip file should start downloading. in the network tab, you will see a HTTP POST to

http://192.168.99.100:28199/api/gen/clients/csharp

To verify the code generation is produced locally, In Kitematic under the swaggercompleteselfhosted_codegen_1 container you should see a log

looking for fileId 178b167b-641d-41d6-a396-c864df847e33
got filename /tmp/codegen-7652262760374524981-tmp/csharp-client-bundle.zip

this is getting generated from your local environment.

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

History

  • V1

License

Copyright @ 2016 Spudmash Media Pty Ltd

About

Docker Compose file to generate a complete Swagger Development environment (Editor + Generator)

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published