https://github.com/bajcmartinez/flask-api-starter-kit

Flask API Starter Kit
https://github.com/bajcmartinez/flask-api-starter-kit

api flask python starter-kit swagger

Last synced: 3 months ago
JSON representation

Flask API Starter Kit

• Host: GitHub
• URL: https://github.com/bajcmartinez/flask-api-starter-kit
• Owner: bajcmartinez
• License: mit
• Created: 2020-05-21T19:47:23.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-08-16T06:07:12.000Z (about 2 years ago)
• Last Synced: 2024-06-04T23:00:05.637Z (5 months ago)
• Topics: api, flask, python, starter-kit, swagger
• Language: Python
• Homepage: https://livecodestream.dev/post/2020-05-21-python-flask-api-starter-kit-and-project-layout/
• Size: 29.3 KB
• Stars: 137
• Watchers: 2
• Forks: 51
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - bajcmartinez/flask-api-starter-kit - Flask API Starter Kit (Python)

README

        
# Flask API Starter Kit

Sample API layout structure to be used as a baseline for other apps

## Dependencies

- [flask](https://palletsprojects.com/p/flask/): Python server of choise

- [flasgger](https://github.com/flasgger/flasgger): Used to generate the swagger documentation

- [flask-marshmallow](https://flask-marshmallow.readthedocs.io/en/latest/): My favourite serializer

- [apispec](https://apispec.readthedocs.io/en/latest/): Required for the integration between marshmallow and flasgger

## Set Up

1. Check out the code

2. Install requirements

    ```

    pipenv install

    ```

3. Start the server with:

    ```

   pipenv run python -m flask run

    ```

   

4. Visit http://localhost/api for the home api

4. Visit http://localhost/apidocs for the swagger documentation

   

## Tests

The code is covered by tests, to run the tests please execute

```

pipenv run python -m unittest

```