Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/marcgibbons/django-rest-swagger

Swagger Documentation Generator for Django REST Framework: deprecated
https://github.com/marcgibbons/django-rest-swagger

coreapi django-rest-framework openapi swagger-ui

Last synced: about 1 month ago
JSON representation

Swagger Documentation Generator for Django REST Framework: deprecated

Lists

README 

        
# Django REST Swagger: deprecated (2019-06-04)



This project is no longer being maintained. Please consider **drf-yasg** as an alternative/successor. I haven't personally used it, but it looks feature-complete and is actively maintained.



### https://github.com/axnsan12/drf-yasg



Thanks for all the support and contributions over the years. Special thanks to [Lights on Software](https://lightsonsoftware.com/), [Lincoln Loop](https://lincolnloop.com/) and BNOTIONS for generously donating time to work on this project :heart:.



---



[![build-status-badge]][build-status]

[![codecov](https://codecov.io/gh/marcgibbons/django-rest-swagger/branch/master/graph/badge.svg)](https://codecov.io/gh/marcgibbons/django-rest-swagger)

[![pypi-version]][pypi]



[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)



#### An API documentation generator for Swagger UI and Django REST Framework



Full documentation: http://marcgibbons.github.io/django-rest-swagger/



## Installation



1. `pip install django-rest-swagger`



2. Add `rest_framework_swagger` to your `INSTALLED_APPS` setting:



    ```python

        INSTALLED_APPS = (

            ...

            'rest_framework_swagger',

        )

    ```



## Rendering Swagger Specification and Documentation



This package ships with two renderer classes:



1. `OpenAPIRenderer` generates the OpenAPI (fka Swagger) JSON schema specification. This renderer will be presented if:

  -  `Content-Type: application/openapi+json` is specified in the headers.

  - `?format=openapi` is passed as query param

2. `SwaggerUIRenderer` generates the Swagger UI and requires the `OpenAPIRenderer`



### Quick Start Example:

```python

from django.conf.urls import url

from rest_framework_swagger.views import get_swagger_view



schema_view = get_swagger_view(title='Pastebin API')



urlpatterns = [

    url(r'^$', schema_view)

]

```



## Requirements

* Django 1.8+

* Django REST framework 3.5.1+

* Python 2.7, 3.5, 3.6



## Testing



- Run `$ tox` to execute the test suite against all supported environments.

- Run `./runtests.py` to run the test suite within the current environment.



## Bugs & Contributions

Please report bugs by opening an issue



Contributions are welcome and are encouraged!



## Special Thanks

Many thanks to Tom Christie & all the contributors who have developed [Django REST Framework](http://django-rest-framework.org/)



[build-status-badge]: https://travis-ci.org/marcgibbons/django-rest-swagger.svg?branch=master

[build-status]: https://travis-ci.org/marcgibbons/django-rest-swagger

[pypi-version]: https://img.shields.io/pypi/v/django-rest-swagger.svg

[pypi]: https://pypi.python.org/pypi/django-rest-swagger

[license]: https://pypi.python.org/pypi/django-rest-swagger/

[docs-badge]: https://readthedocs.io/projects/django-rest-swagger/badge/

[docs]: http://django-rest-swagger.readthedocs.io/