Skip to content

Commit

Permalink
Add drf-spectacular recommendation
Browse files Browse the repository at this point in the history
  • Loading branch information
axnsan12 committed Oct 25, 2020
1 parent addc18f commit c67bcca
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 1 deletion.
2 changes: 1 addition & 1 deletion CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ You want to contribute some code? Great! Here are a few steps to get you started

.. code:: console
$ virtualenv venv
$ python -m venv venv
$ source venv/bin/activate
(venv) $ python -m pip install -U pip setuptools
(venv) $ pip install -U -e .[validation]
Expand Down
13 changes: 13 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,19 @@ Resources:

|heroku-button|


****************
OpenAPI 3.0 note
****************

If you are looking to add Swagger/OpenAPI support to a new project you might want to take a look at
`drf-spectacular <https://github.com/tfranzel/drf-spectacular>`_, which is an actively maintained new library that
shares most of the goals of this project, while working with OpenAPI 3.0 schemas.

OpenAPI 3.0 provides a lot more flexibility than 2.0 in the types of API that can be described.
``drf-yasg`` is unlikely to soon, if ever, get support for OpenAPI 3.0.


********
Features
********
Expand Down

0 comments on commit c67bcca

Please sign in to comment.