[DEPRECATED] Beautiful Django Rest Framework API documentation autogeneration through OpenAPI standard
.. image:: https://img.shields.io/pypi/v/drfopenapi.svg :target: https://pypi.python.org/pypi/drfopenapi
.. image:: https://img.shields.io/travis/limdauto/drfopenapi.svg :target: https://travis-ci.org/limdauto/drfopenapi
.. image:: https://readthedocs.org/projects/drf-openapi/badge/?version=latest :target: https://drf-openapi.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status
.. image:: https://pyup.io/repos/github/limdauto/drfopenapi/shield.svg :target: https://pyup.io/repos/github/limdauto/drfopenapi/ :alt: Updates
.. image:: https://badges.gitter.im/drfopenapi/Lobby.svg :target: https://gitter.im/drfopenapi/Lobby?utmsource=badge&utmmedium=badge&utmcampaign=pr-badge&utmcontent=badge :alt: Join the chat at https://gitter.im/drf_openapi/Lobby
DEPRECATION NOTICE This project is deprecated in favour of https://github.com/axnsan12/drf-yasg/ or if you can wait https://github.com/encode/django-rest-framework/commit/e5781440fa6ccff09abc6e0566bdfdd9b84a80a1 :) :) :)
Generates OpenAPI-compatible schema from API made with Django Rest Framework. Use
ReDoc_ as default interface instead of Swagger. First-class support for API versioning changelog & method-specific schema definition.
.. figure:: https://raw.githubusercontent.com/limdauto/drf_openapi/master/images/screenshot.png :scale: 80%
Django Rest Framework has an
API schema generation/declaration mechanism_ provided by
coreapi_ standard. There are a couple of problems with the current ecosystem:
OpenAPI_ which is a much more popular API standard with superior tooling support, i.e. Swagger et. al.
This project was born to bridge the gap between DRF and OpenAPI. The high-level requirements are as followed:
It's important to stress the non-intrusiveness requirement, not least because I want to minimize what I will have to change when DRF itself decides to support OpenAPI officially, if at all.
serializerare used interchangably
Currently DRF OpenAPI only supports DRF project that has
versioning_ enabled. I have only tested
URLPathVersioning_ but I intend to suppor the full range of versioning scheme supported by DRF.
Please read the
docs_ for a quickstart.
Also I have recreated the example in
DRF tutorial_ with OpenAPI schema enabled in _.