{"id":13481711,"url":"https://github.com/marcgibbons/django-rest-swagger","last_synced_at":"2025-10-06T10:31:09.002Z","repository":{"id":8940469,"uuid":"10674033","full_name":"marcgibbons/django-rest-swagger","owner":"marcgibbons","description":"Swagger Documentation Generator for Django REST Framework: deprecated","archived":true,"fork":false,"pushed_at":"2020-12-14T12:00:00.000Z","size":7492,"stargazers_count":2591,"open_issues_count":166,"forks_count":601,"subscribers_count":67,"default_branch":"master","last_synced_at":"2024-05-22T15:10:17.411Z","etag":null,"topics":["coreapi","django-rest-framework","openapi","swagger-ui"],"latest_commit_sha":null,"homepage":"https://marcgibbons.com/django-rest-swagger/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/marcgibbons.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-06-13T19:28:32.000Z","updated_at":"2024-05-21T02:00:07.000Z","dependencies_parsed_at":"2022-08-07T05:00:20.678Z","dependency_job_id":null,"html_url":"https://github.com/marcgibbons/django-rest-swagger","commit_stats":null,"previous_names":[],"tags_count":48,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcgibbons%2Fdjango-rest-swagger","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcgibbons%2Fdjango-rest-swagger/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcgibbons%2Fdjango-rest-swagger/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcgibbons%2Fdjango-rest-swagger/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/marcgibbons","download_url":"https://codeload.github.com/marcgibbons/django-rest-swagger/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235519935,"owners_count":19003201,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["coreapi","django-rest-framework","openapi","swagger-ui"],"created_at":"2024-07-31T17:00:54.594Z","updated_at":"2025-10-06T10:31:03.619Z","avatar_url":"https://github.com/marcgibbons.png","language":"Python","funding_links":[],"categories":["Python","HarmonyOS","Best Django Admin Interface Resources","Third-Party Packages","Packages"],"sub_categories":["Windows Manager","**🖥️ Django REST Framework \u0026 API-Related Packages**","Podcasts","Documentation"],"readme":"# Django REST Swagger: deprecated (2019-06-04)\n\nThis 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.\n\n### https://github.com/axnsan12/drf-yasg\n\nThanks 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:.\n\n---\n\n[![build-status-badge]][build-status]\n[![codecov](https://codecov.io/gh/marcgibbons/django-rest-swagger/branch/master/graph/badge.svg)](https://codecov.io/gh/marcgibbons/django-rest-swagger)\n[![pypi-version]][pypi]\n\n\n[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)\n\n\n#### An API documentation generator for Swagger UI and Django REST Framework\n\nFull documentation: http://marcgibbons.github.io/django-rest-swagger/\n\n\n## Installation\n\n1. `pip install django-rest-swagger`\n\n2. Add `rest_framework_swagger` to your `INSTALLED_APPS` setting:\n\n    ```python\n        INSTALLED_APPS = (\n            ...\n            'rest_framework_swagger',\n        )\n    ```\n\n## Rendering Swagger Specification and Documentation\n\nThis package ships with two renderer classes:\n\n1. `OpenAPIRenderer` generates the OpenAPI (fka Swagger) JSON schema specification. This renderer will be presented if:\n  -  `Content-Type: application/openapi+json` is specified in the headers.\n  - `?format=openapi` is passed as query param\n2. `SwaggerUIRenderer` generates the Swagger UI and requires the `OpenAPIRenderer`\n\n\n### Quick Start Example:\n```python\nfrom django.conf.urls import url\nfrom rest_framework_swagger.views import get_swagger_view\n\nschema_view = get_swagger_view(title='Pastebin API')\n\nurlpatterns = [\n    url(r'^$', schema_view)\n]\n```\n\n## Requirements\n* Django 1.8+\n* Django REST framework 3.5.1+\n* Python 2.7, 3.5, 3.6\n\n\n## Testing\n\n- Run `$ tox` to execute the test suite against all supported environments.\n- Run `./runtests.py` to run the test suite within the current environment.\n\n## Bugs \u0026 Contributions\nPlease report bugs by opening an issue\n\nContributions are welcome and are encouraged!\n\n## Special Thanks\nMany thanks to Tom Christie \u0026 all the contributors who have developed [Django REST Framework](http://django-rest-framework.org/)\n\n\n[build-status-badge]: https://travis-ci.org/marcgibbons/django-rest-swagger.svg?branch=master\n[build-status]: https://travis-ci.org/marcgibbons/django-rest-swagger\n[pypi-version]: https://img.shields.io/pypi/v/django-rest-swagger.svg\n[pypi]: https://pypi.python.org/pypi/django-rest-swagger\n[license]: https://pypi.python.org/pypi/django-rest-swagger/\n[docs-badge]: https://readthedocs.io/projects/django-rest-swagger/badge/\n[docs]: http://django-rest-swagger.readthedocs.io/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarcgibbons%2Fdjango-rest-swagger","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarcgibbons%2Fdjango-rest-swagger","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarcgibbons%2Fdjango-rest-swagger/lists"}