# Buildsheet autogenerated by ravenadm tool -- Do not edit.

NAMEBASE=		python-drf-yasg
VERSION=		1.7.0
KEYWORDS=		python devel
VARIANTS=		py35 py36
SDESC[py35]=		Django Swagger/OpenAPI spec generator (PY 35)
SDESC[py36]=		Django Swagger/OpenAPI spec generator (PY 36)
HOMEPAGE=		https://github.com/axnsan12/drf-yasg
CONTACT=		Python_Automaton[python@ironwolf.systems]

DOWNLOAD_GROUPS=	main
SITES[main]=		PYPI/d/drf-yasg
DISTFILE[1]=		drf-yasg-1.7.0.tar.gz:main
DF_INDEX=		1
SPKGS[py35]=		single
SPKGS[py36]=		single

OPTIONS_AVAILABLE=	PY35 PY36
OPTIONS_STANDARD=	none
VOPTS[py35]=		PY35=ON PY36=OFF
VOPTS[py36]=		PY35=OFF PY36=ON

DISTNAME=		drf-yasg-1.7.0

LICENSE=		BSDGROUP:single
LICENSE_FILE=		BSDGROUP:{{WRKSRC}}/LICENSE.rst
LICENSE_SCHEME=		solo

GENERATED=		yes

[PY35].BUILDRUN_DEPENDS_ON=		python-coreapi:single:py35
					python-coreschema:single:py35
					python-openapi-codec:single:py35
					python-ruamel.yaml:single:py35
					python-inflection:single:py35
					python-future:single:py35
					python-six:single:py35
					python-uritemplate:single:py35
					python-djangorestframework:single:py35
					python-Django:single:py35
					python-setuptools_scm:single:py35
[PY35].USES_ON=				python:py35

[PY36].BUILDRUN_DEPENDS_ON=		python-coreapi:single:py36
					python-coreschema:single:py36
					python-openapi-codec:single:py36
					python-ruamel.yaml:single:py36
					python-inflection:single:py36
					python-future:single:py36
					python-six:single:py36
					python-uritemplate:single:py36
					python-djangorestframework:single:py36
					python-Django:single:py36
					python-setuptools_scm:single:py36
[PY36].USES_ON=				python:py36

[FILE:2844:descriptions/desc.single]
.. role:: python(code)
   :language: python

########################################
drf-yasg - Yet another Swagger generator
########################################

|travis| |nbsp| |codecov| |nbsp| |rtd-badge| |nbsp| |pypi-version|

Generate **real** Swagger/OpenAPI 2.0 specifications from a Django Rest
Framework API.

Compatible with

- **Django Rest Framework**: 3.7.7, 3.8.x
- **Django**: 1.11.x, 2.0.x
- **Python**: 2.7, 3.4, 3.5, 3.6

Resources:

* **Source**: https://github.com/axnsan12/drf-yasg/
* **Documentation**: https://drf-yasg.readthedocs.io/
* **Changelog**: https://drf-yasg.readthedocs.io/en/stable/changelog.html
* **Live demo**: https://drf-yasg-demo.herokuapp.com/

.. image:: https://www.herokucdn.com/deploy/button.svg
   :target:
https://heroku.com/deploy?template=https://github.com/axnsan12/drf-yasg
   :alt: heroku deploy button

********
Features
********

- full support for nested Serializers and Schemas
- response schemas and descriptions
- model definitions compatible with codegen tools
- customization hooks at all points in the spec generation process
- JSON and YAML format for spec
- bundles latest version of
  `swagger-ui <https://github.com/swagger-api/swagger-ui>`_ and
  `redoc <https://github.com/Rebilly/ReDoc>`_ for viewing the generated
documentation
- schema view is cacheable out of the box
- generated Swagger schema can be automatically validated by
  `swagger-spec-validator
<https://github.com/Yelp/swagger_spec_validator>`_ or
  `flex <https://github.com/pipermerriam/flex>`_
- supports Django REST Framework API versioning with ``URLPathVersioning``
and ``NamespaceVersioning``; other DRF
  or custom versioning schemes are not currently supported

.. figure::
https://raw.githubusercontent.com/axnsan12/drf-yasg/1.0.2/screenshots/redoc
-nested-response.png
   :width: 100%
   :figwidth: image
   :alt: redoc screenshot

   **Fully nested request and response schemas.**

.. figure::
https://raw.githubusercontent.com/axnsan12/drf-yasg/1.0.2/screenshots/swagg
er-ui-list.png
   :width: 100%
   :figwidth: image
   :alt: swagger-ui screenshot

   **Choose between redoc and swagger-ui.**

.. figure::
https://raw.githubusercontent.com/axnsan12/drf-yasg/1.0.2/screenshots/swagg
er-ui-models.png
   :width: 100%
   :figwidth: image
   :alt: model definitions screenshot

   **Real Model definitions.**


*****************
Table of contents
*****************

.. contents::
   :depth: 4

*****
Usage
*****

0. Installation
===============

The preferred instalation method is directly from pypi:

.. code:: console

   pip install drf-yasg

Additionally, if you want to use the built-in validation mechanisms (see
`4. Validation`_), you need to install
some extra requirements:

.. code:: console

   pip install drf-yasg[validation]

.. _readme-quickstart:

1. Quickstart
=============


[FILE:100:distinfo]
2a73dc3d9d90da5afa9484d8126fd33465eefa02f04113158915cb53578035c6       983066 drf-yasg-1.7.0.tar.gz