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

Docs update

Browse Source
This commit is contained in:
Tom Christie 2016-06-09 21:51:22 +01:00
parent eeffca40eb
commit 6c60f58a56
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/tutorial/7-schemas-and-client-libraries.md
View File

@ -58,12 +58,17 @@ content type in the `Accept` header.
"_type": "document", "_type": "document",
... ...
The default output style is to use the [Core JSON][corejson] encoding.
Other schema formats, such as [Open API][openapi] (formerly Swagger) are
also supported.
## Using a command line client ## Using a command line client
Now that our API is exposing a schema endpoint, we can use a dynamic client Now that our API is exposing a schema endpoint, we can use a dynamic client
library to interact with the API. To demonstrate this, let's use the library to interact with the API. To demonstrate this, let's use the
Core API command line client. We've already installed the `coreapi` package Core API command line client. We've already installed the `coreapi` package
using `pip`, so the client tool should already be available. Check that it using `pip`, so the client tool should already be installed. Check that it
is available on the command line... is available on the command line...
$ coreapi $ coreapi
@ -125,3 +130,5 @@ TODO - authentication
*TODO - document writing an explict schema view.* *TODO - document writing an explict schema view.*
[coreapi]: http://www.coreapi.org [coreapi]: http://www.coreapi.org
[corejson]: http://www.coreapi.org/specification/encoding/#core-json-encoding
[openapi]: https://openapis.org/