Hello 👋🏻,
This is a REST API with that simulates a simple people record database. Post following the setup
instructions, you may want to play around with the API's in either swagger or with the provided
postman collections in /postman folder. Enjoy and happy testing.
Uses Flask, Connexion, Swagger and SQL Alchemy
- Ensure you have pipenv available. Read this blog to understand all about pipenv
- Ensure you have cloned this repo and are in the project root directory that has the
Pipfilewith definitions of all required dependencies. - Execute
pipenv shellto activate the virtualenv in your terminal - Execute
pipenv installto install all dependencies - cd to
people-api - Execute
python server.py - To open swagger navigate to
http://0.0.0.0:5000/api/ui/
On a windows machine, you may want to replace the host as
127.0.0.1in above URL
server.pyhas the code to start the Flask app with connexionpeople.pyhas the implementation for CRUD operations of the people APIswagger.ymlhas the swagger spec to define the route for the API while also allowing to build out a nice swagger documentationstaticdir contains thecssandjsfiles (following MVC) which define the presentation and the interactions with the web apps API
- To install swagger-ui, please run
pipenv install "connexion[swagger-ui]". Read this bug to understand about why zsh needs this to be quoted. - If you are on windows platform,
- Try using
127.0.0.1as the host instead of0.0.0.0 - Also enclose the URL in CURL with double quotes instead of single quotes (Reference thread on stack overflow)
- Try using
This follows the steps from a real python tutorial series written by Doug Farrell
- Part 1: Building API and simple app with connexion, flask, Check out the original repo here
- Part 2: Adding database and ORM (SQL Alchemy). Updated code can be found here
Some useful posts to refer apart from the tutorials