Skip to content

davepartner/swagger-api-sample-documentation-with-gulp-automation

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Swagger API working sample with gulp automating tasks

NPM version This is a completely setup swagger api documentation with swagger ui and swagger project edit already setup. To start documenting your API, you just need to clone it and start writing your API straight up! Dont forget to star it.

I made a complete tutorial for this repository on youtube, you can check it out here => Braintemple Tutorial TV - Lumen API Documentation Tutorial

How to install

  • Star this repository by clicking the star icon on the top right corner of this page
  • Clone this repostory into your system by running git clone https://github.com/daveozoalor/swagger-api-sample-documentation-with-gulp-automation.git
  • CD into the folder and run npm install .
  • Run the following commands to install swagger and gulp npm install -g swagger , npm install -g gulp , npm install -g gulp-cli
  • Then run your migration by running php artisan migrate .
  • You can start the editor server by CDing into the /editor folder and running swagger project edit
  • To see swagger Open API specification document run swagger docs from your command line. Be sure you are connected online, it will open the document on github for you using your favourite broser.

Remember to watch the tutorial on youtube if you have any problems, or just contact me using any of the links below. I can join your team if we have a good talk.

Important links to contact me

Follow me on my social media handles

License

This project is open-sourced software licensed under the MIT license.

About

This is a complete and working swagger setup. You just need to clone it and start adding your own endpoints, hassle free. It includes swagger-ui, swagger-ui-dist, swagger-editor and a cool gulp task to help automate the whole process. No learning curve, just plug and play. Don't forget to star it.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages