widal001 / flask-api-template Goto Github PK

Summary

Upgrade project architecture to make the code base easier to extend and reproduce.

To Do

• Upgrade to python 3.9
• Dockerize the application
• Reorganize the file structure

Summary

Create endpoints and tests for the demo API

Expected Behavior

The following endpoints will be created:

• Books
  • GET api/books/
  • POST api/books/
  • GET api/books/{book_id}/
  • PUT api/books/{book_id}/
• Libraries
  • GET api/libraries/
  • GET api/libraries/{library_id}/books
  • POST api/libraries/{library_id}/books
  • POST api/libraries/{library_id}/books/{book_id}/borrow
  • POST api/libraries/{library_id}/books/{book_id}/return

Summary

Creates swagger documentation for the sample API endpoints

To Do

• Endpoints
  • GET /books
  • POST /books
  • GET /books/<book_id>
  • PUT /books/<book_id>
  • GET /libraries
  • POST /libraries
  • GET /libraries/<lib_id>/books
  • PUT /libraries/<lib_id>/books/<book_id>
  • POST /libraries/<lib_id>/books/<book_id>/borrow
  • POST /libraries/<lib_id>/books/<book_id>/return
• Models
  • Book
  • Library
  • LibraryBook

Summary

Sets up auto-formatting using black, flake8, and pre-commit hooks and add docstrings to the existing code.

To Do

• Auto-formatting
  • Setup pre-commit-config.yaml
  • Setup .toml for black
  • Setup .flake8 for flake8
• Docstrings
  • app.py
  • run.py
  • models
    • library_model.py
    • book_model.py
    • library_book_model.py
  • schemas
    • book_schema.py
    • library_schema.py
  • resources
    • book_resource.py
    • library_resource.py
  • tests
    • conftest.py
    • test_book.py
    • test_library.py
    • test_populate_db.py