FlaskAPI is an Application Programming interface , which showcases standard REST API calls developed on python, with the help of flask_restplus module. This project is based on the Swagger UI documentation format.
To setup the project on your local machine, follow the steps listed below:-
-
Clone the project to a directory on your system, for eg. FLaskAPI/.
-
Change the directory to FlaskAPI/ , and run :
python a2.py
- After running the command mentioned above, you will see the project running on your machine as follows:
* Serving Flask app "a2" (lazy loading)
* Environment: production
WARNING: This is a development server. Do not use it in a production deployment.
Use a production WSGI server instead.
* Debug mode: on
* Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
* Restarting with stat
* Debugger is active!
-
Now open your browser and go to the link the project is running on, in this case it is http://127.0.0.1:5000/ .
-
Once you've opened the link in the browser , you can open the collections dropdown and call a request of your choice, by clicking on the button labelled POST, DELETE etc.