encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-07-28 08:59:54 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update docs for OpenAPI (#6814)

Browse Source
This commit is contained in:
dalei 2020-02-15 23:58:49 +08:00
parent f81ca78642
commit e92e61104f
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/api-guide/schemas.md
View File

@ -18,12 +18,12 @@ Django REST Framework provides support for automatic generation of
## Generating an OpenAPI Schema ## Generating an OpenAPI Schema
### Install `pyyaml` ### Install dependencies
You'll need to install `pyyaml`, so that you can render your generated schema pip install pyyaml uritemplate
into the commonly used YAML-based OpenAPI format.
pip install pyyaml * `pyyaml` is used to generate schema into YAML-based OpenAPI format.
* `uritemplate` is used internally to get parameters in path.
### Generating a static schema with the `generateschema` management command ### Generating a static schema with the `generateschema` management command