Merge pull request #17 from rodrigofeijao/feat/add-fastapi-example

Add fastapi basic example

Author: patrick91

README.md

@@ -1,3 +1,8 @@
-# examples
+# Examples
 
-Example on how to use Strawberry
+Examples on how to use Strawberry:
+
+1. [Django Subscriptions](/django-subscriptions)
+2. [Django Subscriptions with RXDB](/django-subscriptions-rxdb/)
+3. [FastAPI](/fastapi/)
+4. [FastAPI with SQL-Alchemy](/fastapi-sqlalchemy)

fastapi/.projectroot

@@ -0,0 +1,38 @@
+# Example of a GraphQL API using Strawberry and FastAPI
+
+This examples shows you how to setup Strawberry with FastAPI
+
+## How to use
+
+1. Install dependencies
+
+Use [poetry](https://python-poetry.org/) to install dependencies:
+
+```bash
+poetry install
+```
+
+2. Run the server
+
+Run [uvicorn](https://www.uvicorn.org/) to run the server:
+
+```bash
+poetry run uvicorn main:app --reload
+```
+
+3. Access the GraphiQL IDE and explore the schema at [http://localhost:8000/graphql](http://localhost:8000/graphql)
+
+## Example query
+
+```graphql
+query AllTopRatedMovies {
+  topRatedMovies {
+    imageUrl
+    imdbId
+    imdbRating
+    imdbRatingCount
+    title
+    year
+  }
+}
+```

fastapi/README.md

@@ -0,0 +1,11 @@
+import strawberry
+
+
+@strawberry.type
+class Movie:
+    imdb_id: str = strawberry.field(description="This is the IMDB ID of the movie")
+    title: str
+    year: int
+    image_url: str
+    imdb_rating: float
+    imdb_rating_count: str

fastapi/api/__init__.py

@@ -0,0 +1,33 @@
+from typing import List
+
+import json
+import strawberry
+
+from .definitions.movie import Movie
+
+
+@strawberry.type
+class Query:
+    @strawberry.field
+    def top_rated_movies(self, info, limit: int = 250) -> List[Movie]:
+        with open("../common-data/movies.json", "r") as file:
+            data = json.load(file)
+
+        result = []
+
+        for i in range(limit):
+            result.append(
+                Movie(
+                    imdb_id=data[i]["imdb_id"],
+                    title=data[i]["title"],
+                    year=data[i]["year"],
+                    image_url=data[i]["image_url"],
+                    imdb_rating=data[i]["imdb_rating"],
+                    imdb_rating_count=data[i]["imdb_rating_count"],
+                )
+            )
+
+        return result
+
+
+schema = strawberry.Schema(Query)

fastapi/api/definitions/__init__.py

@@ -0,0 +1,18 @@
+from fastapi import FastAPI, Request
+from fastapi.templating import Jinja2Templates
+from fastapi.responses import HTMLResponse
+from strawberry.asgi import GraphQL
+
+from api.schema import schema
+
+app = FastAPI()
+
+templates = Jinja2Templates(directory="templates")
+
+
+@app.get("/", response_class=HTMLResponse)
+async def render_index_page(request: Request):
+    return templates.TemplateResponse("index.html", {"request": request})
+
+
+app.mount("/graphql", GraphQL(schema))

fastapi/api/definitions/movie.py

@@ -0,0 +1,29 @@
+[tool.poetry]
+name = "strawberry-graphql-fastapi-example"
+version = "0.1.0"
+description = "Example of a GraphQL API using Strawberry and FastAPI"
+authors = ["Rodrigo Feijao <[email protected]>"]
+
+[tool.poetry.dependencies]
+python = "^3.11"
+uvicorn = {extras = ["standard"], version = "^0.24.0"}
+strawberry-graphql = {extras = ["asgi"], version = "^0.214.0"}
+fastapi = "^0.104.1"
+
+
+[tool.poetry.dev-dependencies]
+black = "^23.11"
+mypy = "^1.7.0"
+ruff = "^0.0.47"
+
+[build-system]
+requires = ["poetry-core>=1.8.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.ruff]
+line-length = 88
+select = [
+    "F401",
+    "F403",
+    "E501",
+]