encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-02-03 13:14:30 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update docs for OpenAPI (#6814) (#7191)

Browse Source
This commit is contained in:
Dalei 2020-02-19 19:56:12 +08:00 committed by GitHub
parent d7b218f5eb
commit 39dd34f161
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
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
### Install `pyyaml`
### Install dependencies
You'll need to install `pyyaml`, so that you can render your generated schema
into the commonly used YAML-based OpenAPI format.
pip install pyyaml uritemplate
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