{ "info": { "author": "TakesxiSximada", "author_email": "sximada+django-rest-swagger-swaggerdoc@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 1 - Planning", "License :: OSI Approved :: Apache Software License", "Programming Language :: Python", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Topic :: Software Development" ], "description": "django-rest-swagger-swaggerdoc - Additional Document\n====================================================\n\n.. image:: https://circleci.com/gh/TakesxiSximada/django-rest-swagger-swaggerdoc.svg?style=svg\n :target: https://circleci.com/gh/TakesxiSximada/django-rest-swagger-swaggerdoc\n :alt: CircleCI Status\n\n.. image:: https://codecov.io/gh/TakesxiSximada/django-rest-swagger-swaggerdoc/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/TakesxiSximada/django-rest-swagger-swaggerdoc\n :alt: CodeCov Status\n\nDjango REST Swagger 2.0 has changed drastically. For example, you may not put a return code in YAML files.\nThis package provides functions to inject a swagger style yaml data to the django-rest-swagger's data.\n\n\nHow to use it\n-------------\n\n1. Add rest_framework_swagger to your INSTALLED_APPS setting\n\n settings.py::\n\n INSTALLED_APPS = (\n ...\n 'rest_framework_swagger',\n )\n\n\n2. You create a swagger style yaml file.\n\n This YAML file is swagger style.\n\n ./api_test_doc.yml::\n\n get:\n description: test document\n responses:\n 200:\n description: success\n 400:\n description: bad request\n schema:\n type: json\n headers:\n Content-Type: application/json\n\n\n3. You create api view function or ViewClass.\n\n The swaggerdoc decorator to specify the relative path from the file\n the view callable is defined.\n\n views.py::\n\n from rest_framework.decorators import api_view\n from rest_framework.views import APIView\n\n from django_rest_swagger_swaggerdoc import swaggerdoc\n\n @swaggerdoc('api_test_doc.yml')\n @api_view()\n def example_view(request):\n pass\n\n class ExampleView(APIView):\n @swaggerdoc('./api_test_doc.yml')\n def get(self, request):\n pass\n\n4. You create document schema view.\n\n Use django_rest_swagger_swaggerdoc.renderers.SwaggerAdditinalDocRenderer.\n DO NOT USE rest_framework_swagger.renderers.OpenAPIRenderer.\n\n views.py::\n\n from rest_framework_swagger.renderers import SwaggerUIRenderer\n from rest_framework.decorators import api_view, renderer_classes\n from rest_framework import response, schemas\n\n from django_rest_swagger_swaggerdoc.renderers import SwaggerAdditinalDocRenderer\n\n\n @api_view()\n @renderer_classes([SwaggerUIRenderer, SwaggerAdditinalDocRenderer])\n def schema_view(request):\n generator = schemas.SchemaGenerator(title='Pastebin API')\n return response.Response(generator.get_schema(request=request))\n\n\nSee example project: https://github.com/TakesxiSximada/django-rest-swagger-swaggerdoc/tree/master/examples\n\nInstall\n-------\n\n::\n\n $ pip install django-rest-swagger-swaggerdoc\n\n\nIt is depends on djangorestframework(>= 3.4.7).\nIf older than version 3.7.4, it may not be able to correctly resolve the YAML path.\n\n\nOther\n-----\n\n- PyPI: https://pypi.python.org/pypi/django-rest-swagger-swaggerdoc\n- Github: https://github.com/TakesxiSximada/django-rest-swagger-swaggerdoc\n- CircleCI: https://circleci.com/gh/TakesxiSximada/django-rest-swagger-swaggerdoc\n- CodeCov: https://codecov.io/gh/TakesxiSximada/django-rest-swagger-swaggerdoc\n\n\n", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/TakesxiSximada/django-rest-swagger-swaggerdoc", "keywords": "Documentation,Swagger", "license": "Apache License 2.0", "maintainer": "", "maintainer_email": "", "name": "django-rest-swagger-swaggerdoc", "package_url": "https://pypi.org/project/django-rest-swagger-swaggerdoc/", "platform": "any", "project_url": "https://pypi.org/project/django-rest-swagger-swaggerdoc/", "project_urls": { "Homepage": "https://github.com/TakesxiSximada/django-rest-swagger-swaggerdoc" }, "release_url": "https://pypi.org/project/django-rest-swagger-swaggerdoc/1.0.post3/", "requires_dist": [ "Django", "PyYAML", "django-rest-swagger", "djangorestframework (>=3.4.7)", "six", "zope.dottedname", "Django; extra == 'testing'", "PyYAML; extra == 'testing'", "coverage; extra == 'testing'", "detox; extra == 'testing'", "django-rest-swagger; extra == 'testing'", "djangorestframework (>=3.4.7); extra == 'testing'", "flake8; extra == 'testing'", "mock; extra == 'testing'", "pytest; extra == 'testing'", "pytest-django; extra == 'testing'", "six; extra == 'testing'", "zope.dottedname; extra == 'testing'" ], "requires_python": "", "summary": "Inject a swagger style yaml data to the django-rest-swagger's data", "version": "1.0.post3" }, "last_serial": 2356411, "releases": { "1.0": [ { "comment_text": "", "digests": { "md5": "940bbce908ebec15b7167f07e4b66c28", "sha256": "f5026c3a3914025c8ca41796ed6230c75843f96d1df958b31ab8593da06009db" }, "downloads": -1, "filename": "django_rest_swagger_swaggerdoc-1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "940bbce908ebec15b7167f07e4b66c28", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 11422, "upload_time": "2016-09-21T15:07:56", "url": "https://files.pythonhosted.org/packages/88/37/857600fda75d1014932ccbf1f20cac8b13e36dbebb0a3160df96079977f6/django_rest_swagger_swaggerdoc-1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "51a014c654585b7bfea508da09841589", "sha256": "2711f5e7fb4b271cebbe583e88a4d4734dbc8cc727a929a2537f53b5c61443a3" }, "downloads": -1, "filename": "django-rest-swagger-swaggerdoc-1.0.tar.gz", "has_sig": false, "md5_digest": "51a014c654585b7bfea508da09841589", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6719, "upload_time": "2016-09-21T15:08:00", "url": "https://files.pythonhosted.org/packages/fb/4f/7218165d02bc267824e62e3222d313490da4af55a38848aad31199316640/django-rest-swagger-swaggerdoc-1.0.tar.gz" } ], "1.0.post1": [ { "comment_text": "", "digests": { "md5": "c1695dac562f7d72ef988051c54274b6", "sha256": "c77c434f390878656e05964eba9b709a27bd70361ac0628b9bdfc5534cfc5678" }, "downloads": -1, "filename": "django_rest_swagger_swaggerdoc-1.0.post1-py3-none-any.whl", "has_sig": false, "md5_digest": "c1695dac562f7d72ef988051c54274b6", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 12048, "upload_time": "2016-09-21T17:05:46", "url": "https://files.pythonhosted.org/packages/b1/b1/a46bcd2270d26d6a764c7993c47d7f5039529905cff29e275573d6d92278/django_rest_swagger_swaggerdoc-1.0.post1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "add1472b7a8d0150116e552e55f399b2", "sha256": "ed4b8a740089d24f761ca6944b27f5bd663024228ec9fd25c78aab0f7fad36d9" }, "downloads": -1, "filename": "django-rest-swagger-swaggerdoc-1.0.post1.tar.gz", "has_sig": false, "md5_digest": "add1472b7a8d0150116e552e55f399b2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7423, "upload_time": "2016-09-21T17:05:48", "url": "https://files.pythonhosted.org/packages/4f/7d/355522da04c3929b93c4cbfb9aa9703fcf75e4e53e4efcec8a7326dce9bc/django-rest-swagger-swaggerdoc-1.0.post1.tar.gz" } ], "1.0.post2": [ { "comment_text": "", "digests": { "md5": "acd710644e010b33261fe29d89252371", "sha256": "93af9dde39625441c4139df6a5073b1ccb5edf21d49135aa6df97c880e53a207" }, "downloads": -1, "filename": "django_rest_swagger_swaggerdoc-1.0.post2-py3-none-any.whl", "has_sig": false, "md5_digest": "acd710644e010b33261fe29d89252371", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 12060, "upload_time": "2016-09-21T17:10:17", "url": "https://files.pythonhosted.org/packages/41/b2/1d2648614906f4c3691ba5b3487684b5f9267e9b6afaf262938377b96106/django_rest_swagger_swaggerdoc-1.0.post2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "fe560c193dfea71df618d6c2dc1d3287", "sha256": "8381cae839213dd87ee3dd777849add9b666e741eb7198b95367a55d47a42c12" }, "downloads": -1, "filename": "django-rest-swagger-swaggerdoc-1.0.post2.tar.gz", "has_sig": false, "md5_digest": "fe560c193dfea71df618d6c2dc1d3287", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7433, "upload_time": "2016-09-21T17:10:20", "url": "https://files.pythonhosted.org/packages/b9/af/f44a360ec58594d9e460c0c1254856349010c37121f6c389c387e3362617/django-rest-swagger-swaggerdoc-1.0.post2.tar.gz" } ], "1.0.post3": [ { "comment_text": "", "digests": { "md5": "f69e1ca1bfa881fa136890633e5311d0", "sha256": "fddcd76894ba1352433e092bfa6db51841cf0787968d09626c6d317a8433cb84" }, "downloads": -1, "filename": "django_rest_swagger_swaggerdoc-1.0.post3-py3-none-any.whl", "has_sig": false, "md5_digest": "f69e1ca1bfa881fa136890633e5311d0", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 12126, "upload_time": "2016-09-22T02:21:45", "url": "https://files.pythonhosted.org/packages/da/9a/afac92b3c68561e5c815f6895e00b7b5b76ac0d10e06f478a648f04cccdf/django_rest_swagger_swaggerdoc-1.0.post3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "d234804d94ed1f67132028cb62a0ebd1", "sha256": "e3c733fcbc26c30a435c02003211a9b901368d127eae5bb7c8527bffe79d7ac2" }, "downloads": -1, "filename": "django-rest-swagger-swaggerdoc-1.0.post3.tar.gz", "has_sig": false, "md5_digest": "d234804d94ed1f67132028cb62a0ebd1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7435, "upload_time": "2016-09-22T02:21:48", "url": "https://files.pythonhosted.org/packages/c4/cf/bacf236630bb72470ab6c4b8bf435e128ae21ab2ee62ad27b655e13af593/django-rest-swagger-swaggerdoc-1.0.post3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "f69e1ca1bfa881fa136890633e5311d0", "sha256": "fddcd76894ba1352433e092bfa6db51841cf0787968d09626c6d317a8433cb84" }, "downloads": -1, "filename": "django_rest_swagger_swaggerdoc-1.0.post3-py3-none-any.whl", "has_sig": false, "md5_digest": "f69e1ca1bfa881fa136890633e5311d0", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 12126, "upload_time": "2016-09-22T02:21:45", "url": "https://files.pythonhosted.org/packages/da/9a/afac92b3c68561e5c815f6895e00b7b5b76ac0d10e06f478a648f04cccdf/django_rest_swagger_swaggerdoc-1.0.post3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "d234804d94ed1f67132028cb62a0ebd1", "sha256": "e3c733fcbc26c30a435c02003211a9b901368d127eae5bb7c8527bffe79d7ac2" }, "downloads": -1, "filename": "django-rest-swagger-swaggerdoc-1.0.post3.tar.gz", "has_sig": false, "md5_digest": "d234804d94ed1f67132028cb62a0ebd1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7435, "upload_time": "2016-09-22T02:21:48", "url": "https://files.pythonhosted.org/packages/c4/cf/bacf236630bb72470ab6c4b8bf435e128ae21ab2ee62ad27b655e13af593/django-rest-swagger-swaggerdoc-1.0.post3.tar.gz" } ] }