init

Author: mjhea0

.gitignore

@@ -0,0 +1,2 @@
+__pycache__
+env

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Michael Herman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,19 @@
+# Developing and Testing an Asynchronous API with FastAPI and Pytest
+
+## Want to learn how to build this?
+
+Check out the [post](https://testdriven.io/blog/fastapi-crud).
+
+## Want to use this project?
+
+Build the images and run the containers:
+
+```sh
+$ docker-compose up -d --build
+```
+
+Test out the following routes:
+
+1. [http://localhost:8002/ping](http://localhost:8002/ping)
+1. [http://localhost:8002/docs](http://localhost:8002/docs)
+1. [http://localhost:8002/notes](http://localhost:8002/notes)

docker-compose.yml

@@ -0,0 +1,23 @@
+version: '3.7'
+
+services:
+  web:
+    build: ./src
+    command: uvicorn app.main:app --reload --workers 1 --host 0.0.0.0 --port 8000
+    volumes:
+      - ./src/:/usr/src/app/
+    ports:
+      - 8002:8000
+    environment:
+      - DATABASE_URL=postgresql://hello_fastapi:hello_fastapi@db/hello_fastapi_dev
+  db:
+    image: postgres:12.1-alpine
+    volumes:
+      - postgres_data:/var/lib/postgresql/data/
+    environment:
+      - POSTGRES_USER=hello_fastapi
+      - POSTGRES_PASSWORD=hello_fastapi
+      - POSTGRES_DB=hello_fastapi_dev
+
+volumes:
+  postgres_data:

src/Dockerfile

@@ -0,0 +1,24 @@
+# pull official base image
+FROM python:3.8.1-alpine
+
+# set work directory
+WORKDIR /usr/src/app
+
+# set environment variables
+ENV PYTHONDONTWRITEBYTECODE 1
+ENV PYTHONUNBUFFERED 1
+
+# copy requirements file
+COPY ./requirements.txt /usr/src/app/requirements.txt
+
+# install dependencies
+RUN set -eux \
+    && apk add --no-cache --virtual .build-deps build-base \
+        libressl-dev libffi-dev gcc musl-dev python3-dev \
+        postgresql-dev \
+    && pip install --upgrade pip setuptools wheel \
+    && pip install -r /usr/src/app/requirements.txt \
+    && rm -rf /root/.cache/pip
+
+# copy project
+COPY . /usr/src/app/

src/app/__init__.py

@@ -0,0 +1,32 @@
+from app.api.models import NoteSchema
+from app.db import notes, database
+
+
+async def post(payload: NoteSchema):
+    query = notes.insert().values(title=payload.title, description=payload.description)
+    return await database.execute(query=query)
+
+
+async def get(id: int):
+    query = notes.select().where(id == notes.c.id)
+    return await database.fetch_one(query=query)
+
+
+async def get_all():
+    query = notes.select()
+    return await database.fetch_all(query=query)
+
+
+async def put(id: int, payload: NoteSchema):
+    query = (
+        notes
+        .update()
+        .where(id == notes.c.id)
+        .values(title=payload.title, description=payload.description)
+    )
+    return await database.execute(query=query)
+
+
+async def delete(id: int):
+    query = notes.delete().where(id == notes.c.id)
+    return await database.execute(query=query)

src/app/api/__init__.py

@@ -0,0 +1,10 @@
+from pydantic import BaseModel, Field
+
+
+class NoteSchema(BaseModel):
+    title: str = Field(..., min_length=3, max_length=50)
+    description: str = Field(..., min_length=3, max_length=50)
+
+
+class NoteDB(NoteSchema):
+    id: int

src/app/api/crud.py

@@ -0,0 +1,59 @@
+from typing import List
+
+from app.api import crud
+from app.api.models import NoteDB, NoteSchema
+from fastapi import APIRouter, HTTPException, Path
+
+router = APIRouter()
+
+
+@router.post("/", response_model=NoteDB, status_code=201)
+async def create_note(payload: NoteSchema):
+    note_id = await crud.post(payload)
+
+    response_object = {
+        "id": note_id,
+        "title": payload.title,
+        "description": payload.description,
+    }
+    return response_object
+
+
+@router.get("/{id}/", response_model=NoteDB)
+async def read_note(id: int = Path(..., gt=0),):
+    note = await crud.get(id)
+    if not note:
+        raise HTTPException(status_code=404, detail="Note not found")
+    return note
+
+
+@router.get("/", response_model=List[NoteDB])
+async def read_all_notes():
+    return await crud.get_all()
+
+
+@router.put("/{id}/", response_model=NoteDB)
+async def update_note(payload: NoteSchema, id: int = Path(..., gt=0),):
+    note = await crud.get(id)
+    if not note:
+        raise HTTPException(status_code=404, detail="Note not found")
+
+    note_id = await crud.put(id, payload)
+
+    response_object = {
+        "id": note_id,
+        "title": payload.title,
+        "description": payload.description,
+    }
+    return response_object
+
+
+@router.delete("/{id}/", response_model=NoteDB)
+async def delete_note(id: int = Path(..., gt=0)):
+    note = await crud.get(id)
+    if not note:
+        raise HTTPException(status_code=404, detail="Note not found")
+
+    await crud.delete(id)
+
+    return note