mirror of
https://github.com/rjNemo/fastapi
synced 2026-06-09 20:16:42 +00:00
6205935323
* 🌐 Refactor file structure to support internationalization * ✅ Update tests changed after i18n * 🔀 Merge Typer style from master * 🔧 Update MkConfig with Typer-styles * 🎨 Format mkdocs.yml with cannonical form * 🎨 Format mkdocs.yml * 🔧 Update MkDocs config * ➕ Add docs translation scripts dependencies * ✨ Add Typer scripts to handle translations * ✨ Add missing translation snippet to include * ✨ Update contributing docs, add docs for translations * 🙈 Add docs_build to gitignore * 🔧 Update scripts with new locations and docs scripts * 👷 Update docs deploy action with translations * 📝 Add note about languages not supported in the theme * ✨ Add first translation, for Spanish
44 lines
1.4 KiB
Markdown
44 lines
1.4 KiB
Markdown
# GraphQL
|
|
|
|
**FastAPI** has optional support for GraphQL (provided by Starlette directly), using the `graphene` library.
|
|
|
|
You can combine normal FastAPI *path operations* with GraphQL on the same application.
|
|
|
|
## Import and use `graphene`
|
|
|
|
GraphQL is implemented with Graphene, you can check <a href="https://docs.graphene-python.org/en/latest/quickstart/" class="external-link" target="_blank">Graphene's docs</a> for more details.
|
|
|
|
Import `graphene` and define your GraphQL data:
|
|
|
|
```Python hl_lines="1 6 7 8 9 10"
|
|
{!../../../docs_src/graphql/tutorial001.py!}
|
|
```
|
|
|
|
## Add Starlette's `GraphQLApp`
|
|
|
|
Then import and add Starlette's `GraphQLApp`:
|
|
|
|
```Python hl_lines="3 14"
|
|
{!../../../docs_src/graphql/tutorial001.py!}
|
|
```
|
|
|
|
!!! info
|
|
Here we are using `.add_route`, that is the way to add a route in Starlette (inherited by FastAPI) without declaring the specific operation (as would be with `.get()`, `.post()`, etc).
|
|
|
|
## Check it
|
|
|
|
Run it with Uvicorn and open your browser at <a href="http://127.0.0.1:8000" class="external-link" target="_blank">http://127.0.0.1:8000</a>.
|
|
|
|
You will see GraphiQL web user interface:
|
|
|
|
<img src="/img/tutorial/graphql/image01.png">
|
|
|
|
## More details
|
|
|
|
For more details, including:
|
|
|
|
* Accessing request information
|
|
* Adding background tasks
|
|
* Using normal or async functions
|
|
|
|
check the official <a href="https://www.starlette.io/graphql/" class="external-link" target="_blank">Starlette GraphQL docs</a>.
|