Merge pull request #56 from febus982/graphql_strawberry

Add example GraphQL endpoint

Author: febus982

http_app/routes/__init__.py

@@ -3,6 +3,7 @@
 from starlette.responses import HTMLResponse
 
 from http_app.routes.api.books import router as api_books_router
+from http_app.routes.graphql import graphql_app
 from http_app.routes.hello import router as hello_router
 from http_app.routes.ping import router as ping_router
 
@@ -14,6 +15,7 @@ def init_versioned_routes(app: FastAPI) -> None:
 def init_unversioned_routes(app: FastAPI) -> None:
     app.include_router(ping_router)
     app.include_router(hello_router)
+    app.include_router(graphql_app, prefix="/graphql")
 
     @app.get("/docs", response_class=HTMLResponse, include_in_schema=False)
     async def get_api_versions() -> HTMLResponse:

http_app/routes/graphql/__init__.py

@@ -0,0 +1,8 @@
+from strawberry import Schema
+from strawberry.fastapi import GraphQLRouter
+
+from .query import Query
+
+schema = Schema(query=Query)
+
+graphql_app: GraphQLRouter = GraphQLRouter(schema)

http_app/routes/graphql/query.py

@@ -0,0 +1,11 @@
+from typing import List
+
+import strawberry
+
+from .resolvers import list_books
+from .types import Book
+
+
+@strawberry.type
+class Query:
+    books: List[Book] = strawberry.field(resolver=list_books)

http_app/routes/graphql/resolvers.py

@@ -0,0 +1,7 @@
+from domains.books import Book, BookService
+
+
+async def list_books():
+    book_service = BookService()
+    books = await book_service.list_books()
+    return [Book(**x.dict()) for x in books]

http_app/routes/graphql/types.py

@@ -0,0 +1,10 @@
+from typing import Union
+
+import strawberry
+
+
+@strawberry.type
+class Book:
+    book_id: Union[int, None] = None
+    title: str
+    author_name: str

poetry.lock

@@ -30,7 +30,8 @@ fastapi-versionizer = "^0.1.2"
 jinja2 = "^3.1.2"
 opentelemetry-instrumentation-fastapi = "*"
 starlette-prometheus = "^0.9.0"
-uvicorn = { version = "^0.22.0", extras = ["standard"] }
+strawberry-graphql = { version = "^0.193.0", extras = ["debug-server", "fastapi"] }
+uvicorn = { version = "^0.21.0", extras = ["standard"] }
 
 [tool.poetry.group.grpc]
 optional = true
@@ -56,6 +57,7 @@ pytest-cov = "*"
 pytest-factoryboy = "*"
 pytest-xdist = "*"
 ruff = "*"
+strawberry-graphql = { version = "*", extras = ["debug-server", "fastapi"] }
 
 [build-system]
 requires = ["poetry-core"]
@@ -78,7 +80,7 @@ files = [
     "di_container.py",
     "config.py",
 ]
-plugins = "pydantic.mypy"
+plugins = "pydantic.mypy,strawberry.ext.mypy_plugin"
 
 [[tool.mypy.overrides]]
 module = "grpc.aio.*"

pyproject.toml

@@ -15,6 +15,15 @@ def book_service() -> Iterator[MagicMock]:
     svc.create_book = AsyncMock(
         side_effect=lambda book: Book(book_id=randint(1, 1000), **book.dict())
     )
+    svc.list_books = AsyncMock(
+        return_value=[
+            Book(
+                book_id=123,
+                title="The Shining",
+                author_name="Stephen King",
+            )
+        ]
+    )
 
     with patch("domains.books._service.BookService.__new__", return_value=svc):
         yield svc

tests/http_app/routes/books/conftest.py

@@ -0,0 +1,24 @@
+from fastapi import status
+from httpx import AsyncClient
+
+
+async def test_create_book(testapp):
+    query = "{books{authorName, title, bookId}}"
+    async with AsyncClient(app=testapp, base_url="http://test") as ac:
+        response = await ac.post(
+            "/graphql",
+            json=dict(query=query),
+        )
+    assert response.status_code == status.HTTP_200_OK
+    assert response.json() == {
+        "data": {
+            "books": [
+                {"authorName": "Stephen King", "bookId": 123, "title": "The Shining"}
+            ]
+        }
+    }
+
+    """
+    Check new_book_data is a subset of response.json()["book"]
+    (response.json()["book"] contains also the generated primary key)
+    """