From e92e61104fc653f809ed43df1d045d552c02c26c Mon Sep 17 00:00:00 2001 From: dalei Date: Sat, 15 Feb 2020 23:58:49 +0800 Subject: [PATCH] Update docs for OpenAPI (#6814) --- docs/api-guide/schemas.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/api-guide/schemas.md b/docs/api-guide/schemas.md index e63fd83e6..6c228d448 100644 --- a/docs/api-guide/schemas.md +++ b/docs/api-guide/schemas.md @@ -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