jjj4x/flask_api_example

Flask REST API Example

Flask REST API Example

The reference Flask API example provides insight into:

• Structuring and Composition
• Building
• Source code documentation
• API documentation
• Testing
• Automation (Tox)
• Using Flask-Marshmallow
• Using APISpec

Installation

Currently the project isn't hosted on PyPI, so you can install it manually.

Development

Build development Docker Image:

tox -e build

Spin up the infrastructure:

tox -e up

Shutdown the infrastructure:

tox -e down

Initialize the database:

tox -e init-db

On Models change, make a new migration:

tox -e make-migration

Migrate:

tox -e migrate

Run Style Guide against the latest code:

tox -e style-guide

Run Unit Tests against the latest code:

tox -e unit-tests

Run Unit Tests with Coverage:

tox -e unit-tests-with-coverage

Show the coverage report:

tox -e coverage-report

Generate documentation from code:

tox -e docs

Generate OpenAPI JSON specification:

tox -e docs-openapi

flask_api_example's Issues

Database

• PostgreSQL
• Setup in Docker
• FlaskSQLAlchemy, Flask-Migrate, SQLAlchemy, Alembic settings
• Provide sane defaults
• Documentation with commands and usage examples
• Database in tests with migrations, cleanups, etc