Briq
/
drf-yasg
6
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Improve README

openapi3
Cristi Vîjdea 2018-01-03 05:45:05 +01:00
parent 6608e0050c
commit a6e24e20c3
1 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.rst
View File

@ -15,9 +15,11 @@ Compatible with
- **Django**: 1.11, 2.0 - **Django**: 1.11, 2.0
- **Python**: 2.7, 3.4, 3.5, 3.6 - **Python**: 2.7, 3.4, 3.5, 3.6
**Source**: https://github.com/axnsan12/drf-yasg/ Resources:
**Documentation**: https://drf-yasg.readthedocs.io/en/latest/ * **Source**: https://github.com/axnsan12/drf-yasg/
* **Documentation**: https://drf-yasg.readthedocs.io/
* **Changelog**: https://drf-yasg.readthedocs.io/en/stable/changelog.html
******** ********
Features Features
@ -145,12 +147,13 @@ This exposes 4 cached, validated and publicly available endpoints:
a. ``get_schema_view`` parameters a. ``get_schema_view`` parameters
--------------------------------- ---------------------------------
- ``info`` - Required. Swagger API Info object - ``info`` - Swagger API Info object; if omitted, defaults to ``DEFAULT_INFO``
- ``url`` - API base url; if left blank will be deduced from the location the view is served at - ``url`` - API base url; if left blank will be deduced from the location the view is served at
- ``patterns`` - passed to SchemaGenerator - ``patterns`` - passed to SchemaGenerator
- ``urlconf`` - passed to SchemaGenerator - ``urlconf`` - passed to SchemaGenerator
- ``public`` - if False, includes only endpoints the current user has access to - ``public`` - if False, includes only endpoints the current user has access to
- ``validators`` - a list of validator names to apply on the generated schema; allowed values are ``flex``, ``ssv`` - ``validators`` - a list of validator names to apply on the generated schema; allowed values are ``flex``, ``ssv``
- ``generator_class`` - schema generator class to use; should be a subclass of ``OpenAPISchemaGenerator``
- ``authentication_classes`` - authentication classes for the schema view itself - ``authentication_classes`` - authentication classes for the schema view itself
- ``permission_classes`` - permission classes for the schema view itself - ``permission_classes`` - permission classes for the schema view itself
@ -166,10 +169,9 @@ b. ``SchemaView`` options
but with optional caching but with optional caching
- you can, of course, call :python:`as_view` as usual - you can, of course, call :python:`as_view` as usual
All of the first 3 methods take two optional arguments, All of the first 3 methods take two optional arguments, ``cache_timeout`` and ``cache_kwargs``; if present,
``cache_timeout`` and ``cache_kwargs``; if present, these are passed on these are passed on to Django’s :python:`cached_page` decorator in order to enable caching on the resulting view.
to Django’s :python:`cached_page` decorator in order to enable caching on the See `3. Caching`_.
resulting view. See `3. Caching`_.
---------------------------------------------- ----------------------------------------------
c. ``SWAGGER_SETTINGS`` and ``REDOC_SETTINGS`` c. ``SWAGGER_SETTINGS`` and ``REDOC_SETTINGS``