Popularity
6.9
Declining
Activity
1.0
-
24
71
565

Programming language: Python
License: BSD 2-clause FreeBSD License
Tags: HTTP     RESTful API     Django     Internet     WWW     Dynamic Content     1.8     1.9     1.10     REST     1.11     2.0     2.1     OpenAPI     Swagger    
Latest version: v2.2.0

Django REST Swagger alternatives and similar packages

Based on the "Django" category

Do you think we are missing an alternative of Django REST Swagger or a related project?

Add another 'Django' Package

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, Lincoln Loop and BNOTIONS for generously donating time to work on this project :heart:.


build-status-badge codecov pypi-version

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:

        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:

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


*Note that all licence references and agreements mentioned in the Django REST Swagger README section above are relevant to that project's source code only.