Code Monkey home page Code Monkey logo

swagger-complete-selfhosted's Introduction

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

swagger-complete-selfhosted's People

Contributors

spudmashmedia avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

tridungle

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.