{ "info": { "author": "Nikolajus Krauklis", "author_email": "nikolajus@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Environment :: Console", "Natural Language :: English", "Operating System :: OS Independent", "Programming Language :: Python", "Topic :: Utilities" ], "description": "RESTful api documentation generation script\n===================\n\nscript to generate restful api documentation out of annotated php code. [Output example you can find here](http://htmlpreview.github.io/?https://raw.github.com/dzhibas/rest-api-doc/master/documentation.html)\n\nannotation example\n\n /**\n * @route /v1/modulename/authentication\n * @method POST\n * @ingroup modulename\n *\n * authentication service example\n *\n * HTTP response code tells about status of login:\n *\n * - 202: Request Accepted\n * - 401: Invalid username/password\n * - 403: Request Denied\n * - 503: Service Unavailable\n *\n * @example input\n *\n * POST /v1/modulename/authentication HTTP/1.1\n * Content-Type: application/json; charset=utf-8\n *\n * {\n * \"username\": \"demousername\",\n * \"passwrod\": \"demopassword\",\n * }\n *\n * @example output\n *\n * {\n * \"message\":\"Request Accepted\",\n * \"id\":386\n * }\n *\n * @jsonparam username extranet username required\n * @jsonparam password extranet password required\n *\n * @returns json\n */\n\nInstallation\n==\npip install -r requirements.txt\n\nUsage\n==\n$ python parse.py -c\n\nHelp\n==\n usage: parse.py [-h] [-c] [-d DIR] [--filter FILTER] [-o OUTPUT]\n\n optional arguments:\n -h, --help show this help message and exit\n -c, --coverage ouputs into stdin documentation coverage\n -d DIR, --dir DIR folder in which we need look for documentation\n annotation. default: test_src_folder/\n --filter FILTER gob filter in which files to search. default:\n *Controler*.php\n -o OUTPUT, --output OUTPUT\n output filename. default: documentation.html\n\nopen generated documentation.html", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/dzhibas/rest-api-doc/", "keywords": null, "license": "UNKNOWN", "maintainer": null, "maintainer_email": null, "name": "restapidoc", "package_url": "https://pypi.org/project/restapidoc/", "platform": "any", "project_url": "https://pypi.org/project/restapidoc/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/dzhibas/rest-api-doc/" }, "release_url": "https://pypi.org/project/restapidoc/0.1.2/", "requires_dist": null, "requires_python": null, "summary": "REST APIs documentation builder tool", "version": "0.1.2" }, "last_serial": 852860, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "1264a9d43c1843070e5267da284b9049", "sha256": "6b1e3a38f0cb8ae37757380faffa843bbe68f8ff9ca98d39f299d343182f9144" }, "downloads": -1, "filename": "restapidoc-0.1.0.tar.gz", "has_sig": false, "md5_digest": "1264a9d43c1843070e5267da284b9049", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6084, "upload_time": "2013-08-30T08:32:57", "url": "https://files.pythonhosted.org/packages/92/cd/f646058ff4f2a407fa04e707d27ab49c4d333d99cf33f9832007e2480132/restapidoc-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "6859a3b21c65370ea9ef071a7e01a5ef", "sha256": "126fed29ab166492c0b67c5272729ef5ae53bb7bfafb2a3d77ed471a0d29e858" }, "downloads": -1, "filename": "restapidoc-0.1.1.tar.gz", "has_sig": false, "md5_digest": "6859a3b21c65370ea9ef071a7e01a5ef", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6090, "upload_time": "2013-08-30T08:48:56", "url": "https://files.pythonhosted.org/packages/f6/47/90c014d0539c8daf701c3d6dafbc6394c8fee05eefda8358226a22b82d47/restapidoc-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "61949b431175779df7797a551221d345", "sha256": "505a54a1372d378915ae95f9cea8515385ee9b32208312990fd2a5cff6f9636d" }, "downloads": -1, "filename": "restapidoc-0.1.2.tar.gz", "has_sig": false, "md5_digest": "61949b431175779df7797a551221d345", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6346, "upload_time": "2013-08-30T08:58:16", "url": "https://files.pythonhosted.org/packages/56/41/1e3abf9a2a73f5ad68420184136137f90906462d1a928b657e5687edf06c/restapidoc-0.1.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "61949b431175779df7797a551221d345", "sha256": "505a54a1372d378915ae95f9cea8515385ee9b32208312990fd2a5cff6f9636d" }, "downloads": -1, "filename": "restapidoc-0.1.2.tar.gz", "has_sig": false, "md5_digest": "61949b431175779df7797a551221d345", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6346, "upload_time": "2013-08-30T08:58:16", "url": "https://files.pythonhosted.org/packages/56/41/1e3abf9a2a73f5ad68420184136137f90906462d1a928b657e5687edf06c/restapidoc-0.1.2.tar.gz" } ] }