This is a boilerplate project for building RESTful APIs using Flask and Flask-RESTful. It provides a solid foundation and a set of best practices to kickstart your API development.
Note: I use this boilerplate for my work projects. It might not be suitable for other use cases without modifications.
- Flask and Flask-RESTful for building RESTful APIs
- SQLAlchemy for database management
- JWT authentication using cookies for secure API access
To get started with the flask-restful-api-boilerplate, follow these steps:
- Clone the repository:
git clone https://github.com/your-username/flask-restful-api-boilerplate.git
- Navigate to the project directory:
cd flask-restful-api-boilerplate
- Create a virtual environment:
python -m venv .venv
- Activate the virtual environment:
- On Windows:
.venv\Scripts\activate
- On macOS/Linux:
source .venv/bin/activate
- On Windows:
- Install the required dependencies:
pip install -r requirements.txt
- Set up the database:
flask db init && flask db migrate && flask db upgrade
- Start the development server:
python app1.py
Contributions are welcome! If you have any suggestions, bug reports, or feature requests, please open an issue or submit a pull request.