{
    "info": {
        "author": "leavesfan",
        "author_email": "leavesfan@gmail.com",
        "bugtrack_url": null,
        "classifiers": [],
        "description": "# django-api-doc\n\nAPI docs for django\n\n## Installation\n\nInstall using `pip`\n\n```\npip install django_api_doc\n```\n\nor\n\n```\ngit clone git@github.com:fanhan/django-api-doc.git\n\ncd django-api-doc/\n\npython setup.py install\n\n```\n\n## Example\n\nAdd `django_api_doc` to your INSTALLED_APPS setting.\n\n```\nINSTALLED_APPS = (\n    ...\n    'django_api_doc',\n)\n```\n\nNow edit the your_project/urls.py module in your project:\n\n```\nurlpatterns = [\n    ...\n    url(r'^api-docs/', include('django_api_doc.urls', namespace='api_docs')),\n]\n```\n\nIn your project `urls.py`, you need set `name` or `namespace`\n\n```\nurlpatterns = [\n    ...\n    url(r'^common/', include('apps.test.urls', namespace='test')),\n]\n```\n\nIn `your_apps/urls.py`, you can set urlpatterns like this...\n\n```\nurlpatterns = [\n    ...\n    url(r'^$', views.TestIndex.as_view(), name='test_index'),\n]\n```\n\n\nIn `view.py`, please use the `markdown` to write comments\n\n```python\n\nclass TestIndexView(View):\n    \"\"\"\n    test\n    \"\"\"\n    \n    def get(self, request):\n        \"\"\"\n        test index\n        \n        #### Param\n        \n        params | category | must | description\n        ---- | ---- | ---- | ----\n        null | null | null | null\n        \n        #### Return\n            {\n                \"text\": \"test\",\n            }\n        \n        \"\"\"\n        pass\n```\n\nthen, open the url `http://127.0.0.1:8000/api-docs/`, you can see like this\n![api_doc_image](https://raw.githubusercontent.com/fanhan/django-api-doc/master/test/api_doc_test.png)\n\n## Add some parameters\n\n```\nAPI_DOC_IGNORE_NAMESPACES = []          # ignore your_project/urls.py namespaces\nAPI_DOC_TITLE = ''                      # doc html title\nAPI_DOC_API_DOMAIN = 'http://api.com'   # api domain\nAPI_DOC_SKIN = 'skin-blue'              # skin-blue skin-black skin-purple skin-yellow skin-red skin-green \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/fanhan/django-api-doc",
        "keywords": "",
        "license": "BSD",
        "maintainer": "",
        "maintainer_email": "",
        "name": "django_api_doc",
        "package_url": "https://pypi.org/project/django_api_doc/",
        "platform": "",
        "project_url": "https://pypi.org/project/django_api_doc/",
        "project_urls": {
            "Homepage": "https://github.com/fanhan/django-api-doc"
        },
        "release_url": "https://pypi.org/project/django_api_doc/0.4/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "API docs for django",
        "version": "0.4"
    },
    "last_serial": 2882191,
    "releases": {
        "0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "9d3d019f01c38715a4b4b8c8bc017b1d",
                    "sha256": "b1c85bb0fa30a22a37e0dea744d1af2d7d55fdef1a1aef566207f887dd6882bb"
                },
                "downloads": -1,
                "filename": "django_api_doc-0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "9d3d019f01c38715a4b4b8c8bc017b1d",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 62224,
                "upload_time": "2016-10-08T02:37:17",
                "url": "https://files.pythonhosted.org/packages/ce/fc/399243ddb62bd2f0e68667a1311a89dc2c9248dc10eb5e041d79a7b6b6c2/django_api_doc-0.1.tar.gz"
            }
        ],
        "0.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "25d5c6d2f1b56c7b2979e196bc433957",
                    "sha256": "394337b0611beebdfcab47139619691d4f3b3e679af8b64b381643c88b2a7253"
                },
                "downloads": -1,
                "filename": "django_api_doc-0.2.tar.gz",
                "has_sig": false,
                "md5_digest": "25d5c6d2f1b56c7b2979e196bc433957",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 62108,
                "upload_time": "2017-04-21T08:17:32",
                "url": "https://files.pythonhosted.org/packages/5b/c9/5f59333cf92ce1dd4d1ea4735449e2bad3131ec3567e6c32859ed93b09ed/django_api_doc-0.2.tar.gz"
            }
        ],
        "0.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "d3c876e4a54e0b3ccee1d95483724bba",
                    "sha256": "aea3bac66f917c777ec48d0243c9f5d8199fdd96c5ec1bb0286ec4fe2019e0c0"
                },
                "downloads": -1,
                "filename": "django_api_doc-0.3.tar.gz",
                "has_sig": false,
                "md5_digest": "d3c876e4a54e0b3ccee1d95483724bba",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 96489,
                "upload_time": "2017-04-27T07:50:24",
                "url": "https://files.pythonhosted.org/packages/59/79/2f6a998306192f26982d37cb54691c686011a737513ae4fa35e4ab39539a/django_api_doc-0.3.tar.gz"
            }
        ],
        "0.4": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "cefd68ce8c33b6c520d3419b6cdcd60e",
                    "sha256": "8680fca936159551001e4147012dab97bf37b2f9388a4391f91885ff4b45809a"
                },
                "downloads": -1,
                "filename": "django_api_doc-0.4.tar.gz",
                "has_sig": false,
                "md5_digest": "cefd68ce8c33b6c520d3419b6cdcd60e",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 96575,
                "upload_time": "2017-05-18T02:31:52",
                "url": "https://files.pythonhosted.org/packages/f4/42/300e539326e531c0c459c7ae8b2e41988f94cf13df75a0f3c642e7e61820/django_api_doc-0.4.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "cefd68ce8c33b6c520d3419b6cdcd60e",
                "sha256": "8680fca936159551001e4147012dab97bf37b2f9388a4391f91885ff4b45809a"
            },
            "downloads": -1,
            "filename": "django_api_doc-0.4.tar.gz",
            "has_sig": false,
            "md5_digest": "cefd68ce8c33b6c520d3419b6cdcd60e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 96575,
            "upload_time": "2017-05-18T02:31:52",
            "url": "https://files.pythonhosted.org/packages/f4/42/300e539326e531c0c459c7ae8b2e41988f94cf13df75a0f3c642e7e61820/django_api_doc-0.4.tar.gz"
        }
    ]
}