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
- 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 documentrunswagger docsfrom 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.
Follow me on my social media handles
-
Subscribe to my channel on Youtube
-
Follow on Braintemple on Twitter and Dave Partner on Twitter
-
Follow me on Instagram
-
You can reach the me on
[email protected], I'd like to join your team. -
Documentation for the Lumen framework can be found on the Lumen website.
-
You going hard or you going home?
This project is open-sourced software licensed under the MIT license.