1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
|
site_name: Django Ninja
site_description: Django Ninja - Django REST framework with high performance, easy to learn, fast to code.
site_url: https://django-ninja.dev
repo_name: vitalik/django-ninja
repo_url: https://github.com/vitalik/django-ninja
edit_uri: ""
extra_css:
- extra.css
extra_javascript:
- javascripts/ask-ai-button.js
theme:
name: material
font: false
palette:
- media: "(prefers-color-scheme)"
primary: green
toggle:
icon: material/brightness-auto
name: Switch to light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: green
toggle:
icon: material/weather-night
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: green
toggle:
icon: material/weather-sunny
name: Switch to light mode
logo: img/docs-logo.png
favicon: img/favicon.svg
language: en
features:
- navigation.expand
- search.highlight
- search.suggest
icon:
repo: fontawesome/brands/github-alt
nav:
- Intro: index.md
- motivation.md
- Tutorial:
- "First Steps": tutorial/index.md
- "Parsing Input": tutorial/step2.md
- "Handling Responses": tutorial/step3.md
- Other Tutorials:
- tutorial/other/video.md
- tutorial/other/crud.md
- How-to Guides:
- Parsing input:
- guides/input/operations.md
- guides/input/path-params.md
- guides/input/query-params.md
- guides/input/body.md
- guides/input/form-params.md
- guides/input/file-params.md
- guides/input/request-parsers.md
- guides/input/filtering.md
- Handling responses:
- Defining a Schema: guides/response/index.md
- guides/response/temporal_response.md
- Generating a Schema from Django models: guides/response/django-pydantic.md
- Generating a Schema dynamically: guides/response/django-pydantic-create-schema.md
- guides/response/config-pydantic.md
- guides/response/pagination.md
- guides/response/response-renderers.md
- Splitting your API with Routers: guides/routers.md
- guides/decorators.md
- guides/authentication.md
- guides/throttling.md
- guides/testing.md
- guides/api-docs.md
- guides/errors.md
- guides/urls.md
- guides/async-support.md
- guides/versioning.md
- Reference:
- NinjaAPI class: reference/api.md
- reference/csrf.md
- reference/operations-parameters.md
- reference/management-commands.md
- reference/settings.md
- releases.md
- help.md
- Enhancement Proposals:
- Intro: proposals/index.md
- proposals/cbv.md
- proposals/v1.md
- What's new in V1: whatsnew_v1.md
markdown_extensions:
- markdown_include.include
- markdown.extensions.codehilite:
guess_lang: false
# Uncomment these 2 lines during development to more easily add highlights
#- pymdownx.highlight:
# linenums: true
- abbr
- codehilite
- admonition
- pymdownx.details
- pymdownx.superfences
plugins:
- search
- mkdocstrings:
handlers:
python:
setup_commands:
- from django.conf import settings
- settings.configure()
|
