https://github.com/cosmic-byte/flask-restplus-boilerplate

A boilerplate for flask restful web service
https://github.com/cosmic-byte/flask-restplus-boilerplate

blueprint flask flask-api flask-restplus jwt-authentication makefile migration sqlalchemy

Last synced: 9 days ago
JSON representation

A boilerplate for flask restful web service

• Host: GitHub
• URL: https://github.com/cosmic-byte/flask-restplus-boilerplate
• Owner: cosmic-byte
• Created: 2018-03-15T10:35:38.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-02-15T21:59:33.000Z (almost 2 years ago)
• Last Synced: 2024-08-14T07:09:40.937Z (4 months ago)
• Topics: blueprint, flask, flask-api, flask-restplus, jwt-authentication, makefile, migration, sqlalchemy
• Language: Python
• Size: 31.3 KB
• Stars: 665
• Watchers: 26
• Forks: 238
• Open Issues: 13
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• jimsghstars - cosmic-byte/flask-restplus-boilerplate - A boilerplate for flask restful web service (Python)

README

        
#### FLASK RESTX BOILER-PLATE WITH JWT

### Terminal commands

Note: make sure you have `pip` and `virtualenv` installed.

    Initial installation: make install

    To run test: make tests

    To run application: make run

    To run all commands at once : make all

Make sure to run the initial migration commands to update the database.

    

    > python manage.py db init

    > python manage.py db migrate --message 'initial database migration'

    > python manage.py db upgrade

### Viewing the app ###

    Open the following url on your browser to view swagger documentation

    http://127.0.0.1:5000/

### Using Postman ####

    Authorization header is in the following format:

    Key: Authorization

    Value: "token_generated_during_login"

    For testing authorization, url for getting all user requires an admin token while url for getting a single

    user by public_id requires just a regular authentication.

### Full description and guide ###

https://medium.freecodecamp.org/structuring-a-flask-restplus-web-service-for-production-builds-c2ec676de563

### Contributing

If you want to contribute to this flask restplus boilerplate, clone the repository and just start making pull requests.

```

https://github.com/cosmic-byte/flask-restplus-boilerplate.git

```