{ "info": { "author": "yuyu1987\u3001hhyo", "author_email": "rtttte@qq.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", "License :: OSI Approved :: Apache Software License", "Operating System :: OS Independent", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7" ], "description": "Swagger2JSON\n==================\n[![Build Status](https://travis-ci.org/hhyo/swagger2json.svg?branch=master)](https://travis-ci.org/hhyo/swagger2json)\n[![codecov](https://codecov.io/gh/hhyo/swagger2json/branch/master/graph/badge.svg)](https://codecov.io/gh/hhyo/swagger2json)\n[![image](https://img.shields.io/pypi/v/swagger2json.svg)](https://pypi.org/project/swagger2json/)\n[![image](https://img.shields.io/pypi/l/swagger2json.svg)](https://github.com/hhyo/swagger2json/blob/master/LICENSE)\n[![image](https://img.shields.io/pypi/pyversions/swagger2json.svg)](https://pypi.org/project/swagger2json/)\n\nGenerate request parameters from the Swagger json \n\nInstallation\n------------\n`pip install swagger2json`\n\n\nUsage\n-------------\n\n```python\n import swagger2json\n import json\n swagger= Swagger(json_url='https://petstore.swagger.io/v2/swagger.json')\n swagger.parse()\n for items in swagger.result:\n print(json.dumps(items, sort_keys=True, indent=4, separators=(',', ': ')).encode('utf-8').decode('unicode_escape'))\n```\n\nExamples\n-------------\n> https://petstore.swagger.io/v2/swagger.json\n\n`python setup.py test`\n\n\n#### Result\n```json\n{\n \"description\": \"\",\n \"if_params_in_url\": false,\n \"method\": \"post\",\n \"name\": \"pet\",\n \"parameters\": {\n \"body\": \"{\n \"category\": {\n \"id\": 1,\n \"name\": \"string\"\n },\n \"id\": 1,\n \"name\": \"string\",\n \"photoUrls\": [\n \"string\"\n ],\n \"status\": \"string\",\n \"tags\": [\n {\n \"id\": 1,\n \"name\": \"string\"\n }\n ]\n }\"\n },\n \"path\": \"/pet\",\n \"summary\": \"Add a new pet to the store\",\n \"tag\": \"Pet\",\n \"type\": [\n \"application/json\",\n \"application/xml\"\n ]\n}\n{\n \"description\": \"\",\n \"if_params_in_url\": false,\n \"method\": \"put\",\n \"name\": \"pet\",\n \"parameters\": {\n \"body\": \"{\n \"category\": {\n \"id\": 1,\n \"name\": \"string\"\n },\n \"id\": 1,\n \"name\": \"string\",\n \"photoUrls\": [\n \"string\"\n ],\n \"status\": \"string\",\n \"tags\": [\n {\n \"id\": 1,\n \"name\": \"string\"\n }\n ]\n }\"\n },\n \"path\": \"/pet\",\n \"summary\": \"Update an existing pet\",\n \"tag\": \"Pet\",\n \"type\": [\n \"application/json\",\n \"application/xml\"\n ]\n}\n{\n \"description\": \"Multiple status values can be provided with comma separated strings\",\n \"if_params_in_url\": false,\n \"method\": \"get\",\n \"name\": \"find_by_status\",\n \"parameters\": {\n \"query\": \"{\n \"status\": []\n }\"\n },\n \"path\": \"/pet/findByStatus\",\n \"summary\": \"Finds Pets by status\",\n \"tag\": \"Pet\",\n \"type\": null\n}\n{\n \"description\": \"Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.\",\n \"if_params_in_url\": false,\n \"method\": \"get\",\n \"name\": \"find_by_tags\",\n \"parameters\": {\n \"query\": \"{\n \"tags\": []\n }\"\n },\n \"path\": \"/pet/findByTags\",\n \"summary\": \"Finds Pets by tags\",\n \"tag\": \"Pet\",\n \"type\": null\n}\n{\n \"description\": \"Returns a single pet\",\n \"if_params_in_url\": true,\n \"method\": \"get\",\n \"name\": \"pet\",\n \"parameters\": {\n \"path\": \"{\n \"petId\": 1\n }\"\n },\n \"path\": \"/pet/{petId}\",\n \"summary\": \"Find pet by ID\",\n \"tag\": \"Pet\",\n \"type\": null\n}\n{\n \"description\": \"\",\n \"if_params_in_url\": true,\n \"method\": \"post\",\n \"name\": \"pet\",\n \"parameters\": {\n \"formData\": \"{\n \"name\": \"string\",\n \"status\": \"string\"\n }\",\n \"path\": \"{\n \"petId\": 1\n }\"\n },\n \"path\": \"/pet/{petId}\",\n \"summary\": \"Updates a pet in the store with form data\",\n \"tag\": \"Pet\",\n \"type\": [\n \"application/x-www-form-urlencoded\"\n ]\n}\n{\n \"description\": \"\",\n \"if_params_in_url\": true,\n \"method\": \"delete\",\n \"name\": \"pet\",\n \"parameters\": {\n \"header\": \"{\n \"api_key\": \"string\"\n }\",\n \"path\": \"{\n \"petId\": 1\n }\"\n },\n \"path\": \"/pet/{petId}\",\n \"summary\": \"Deletes a pet\",\n \"tag\": \"Pet\",\n \"type\": null\n}\n{\n \"description\": \"\",\n \"if_params_in_url\": true,\n \"method\": \"post\",\n \"name\": \"upload_image\",\n \"parameters\": {\n \"formData\": \"{\n \"additionalMetadata\": \"string\",\n \"file\": \"string\"\n }\",\n \"path\": \"{\n \"petId\": 1\n }\"\n },\n \"path\": \"/pet/{petId}/uploadImage\",\n \"summary\": \"uploads an image\",\n \"tag\": \"Pet\",\n \"type\": [\n \"multipart/form-data\"\n ]\n}\n{\n \"description\": \"Returns a map of status codes to quantities\",\n \"if_params_in_url\": false,\n \"method\": \"get\",\n \"name\": \"inventory\",\n \"parameters\": {},\n \"path\": \"/store/inventory\",\n \"summary\": \"Returns pet inventories by status\",\n \"tag\": \"Store\",\n \"type\": null\n}\n{\n \"description\": \"\",\n \"if_params_in_url\": false,\n \"method\": \"post\",\n \"name\": \"order\",\n \"parameters\": {\n \"body\": \"{\n \"complete\": True,\n \"id\": 1,\n \"petId\": 1,\n \"quantity\": 1,\n \"shipDate\": \"string\",\n \"status\": \"string\"\n }\"\n },\n \"path\": \"/store/order\",\n \"summary\": \"Place an order for a pet\",\n \"tag\": \"Store\",\n \"type\": null\n}\n{\n \"description\": \"For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions\",\n \"if_params_in_url\": true,\n \"method\": \"get\",\n \"name\": \"order\",\n \"parameters\": {\n \"path\": \"{\n \"orderId\": 1\n }\"\n },\n \"path\": \"/store/order/{orderId}\",\n \"summary\": \"Find purchase order by ID\",\n \"tag\": \"Store\",\n \"type\": null\n}\n{\n \"description\": \"For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors\",\n \"if_params_in_url\": true,\n \"method\": \"delete\",\n \"name\": \"order\",\n \"parameters\": {\n \"path\": \"{\n \"orderId\": 1\n }\"\n },\n \"path\": \"/store/order/{orderId}\",\n \"summary\": \"Delete purchase order by ID\",\n \"tag\": \"Store\",\n \"type\": null\n}\n{\n \"description\": \"This can only be done by the logged in user.\",\n \"if_params_in_url\": false,\n \"method\": \"post\",\n \"name\": \"user\",\n \"parameters\": {\n \"body\": \"{\n \"email\": \"string\",\n \"firstName\": \"string\",\n \"id\": 1,\n \"lastName\": \"string\",\n \"password\": \"string\",\n \"phone\": \"string\",\n \"userStatus\": 1,\n \"username\": \"string\"\n }\"\n },\n \"path\": \"/user\",\n \"summary\": \"Create user\",\n \"tag\": \"User\",\n \"type\": null\n}\n{\n \"description\": \"\",\n \"if_params_in_url\": false,\n \"method\": \"post\",\n \"name\": \"create_with_array\",\n \"parameters\": {\n \"body\": \"[\n {\n \"email\": \"string\",\n \"firstName\": \"string\",\n \"id\": 1,\n \"lastName\": \"string\",\n \"password\": \"string\",\n \"phone\": \"string\",\n \"userStatus\": 1,\n \"username\": \"string\"\n }\n ]\"\n },\n \"path\": \"/user/createWithArray\",\n \"summary\": \"Creates list of users with given input array\",\n \"tag\": \"User\",\n \"type\": null\n}\n{\n \"description\": \"\",\n \"if_params_in_url\": false,\n \"method\": \"post\",\n \"name\": \"create_with_list\",\n \"parameters\": {\n \"body\": \"[\n {\n \"email\": \"string\",\n \"firstName\": \"string\",\n \"id\": 1,\n \"lastName\": \"string\",\n \"password\": \"string\",\n \"phone\": \"string\",\n \"userStatus\": 1,\n \"username\": \"string\"\n }\n ]\"\n },\n \"path\": \"/user/createWithList\",\n \"summary\": \"Creates list of users with given input array\",\n \"tag\": \"User\",\n \"type\": null\n}\n{\n \"description\": \"\",\n \"if_params_in_url\": false,\n \"method\": \"get\",\n \"name\": \"login\",\n \"parameters\": {\n \"query\": \"{\n \"password\": \"string\",\n \"username\": \"string\"\n }\"\n },\n \"path\": \"/user/login\",\n \"summary\": \"Logs user into the system\",\n \"tag\": \"User\",\n \"type\": null\n}\n{\n \"description\": \"\",\n \"if_params_in_url\": false,\n \"method\": \"get\",\n \"name\": \"logout\",\n \"parameters\": {},\n \"path\": \"/user/logout\",\n \"summary\": \"Logs out current logged in user session\",\n \"tag\": \"User\",\n \"type\": null\n}\n{\n \"description\": \"\",\n \"if_params_in_url\": true,\n \"method\": \"get\",\n \"name\": \"user\",\n \"parameters\": {\n \"path\": \"{\n \"username\": \"string\"\n }\"\n },\n \"path\": \"/user/{username}\",\n \"summary\": \"Get user by user name\",\n \"tag\": \"User\",\n \"type\": null\n}\n{\n \"description\": \"This can only be done by the logged in user.\",\n \"if_params_in_url\": true,\n \"method\": \"put\",\n \"name\": \"user\",\n \"parameters\": {\n \"body\": \"{\n \"email\": \"string\",\n \"firstName\": \"string\",\n \"id\": 1,\n \"lastName\": \"string\",\n \"password\": \"string\",\n \"phone\": \"string\",\n \"userStatus\": 1,\n \"username\": \"string\"\n }\",\n \"path\": \"{\n \"username\": \"string\"\n }\"\n },\n \"path\": \"/user/{username}\",\n \"summary\": \"Updated user\",\n \"tag\": \"User\",\n \"type\": null\n}\n{\n \"description\": \"This can only be done by the logged in user.\",\n \"if_params_in_url\": true,\n \"method\": \"delete\",\n \"name\": \"user\",\n \"parameters\": {\n \"path\": \"{\n \"username\": \"string\"\n }\"\n },\n \"path\": \"/user/{username}\",\n \"summary\": \"Delete user\",\n \"tag\": \"User\",\n \"type\": null\n}\n```\n\nRunning the tests\n-----------------\n`python setup.py test`\n\n\nAcknowledgments\n-----------------\n- https://petstore.swagger.io/v2/swagger.json", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://github.com/hhyo/swagger2json", "keywords": "swagger swagger2json", "license": "Apache 2.0", "maintainer": "", "maintainer_email": "", "name": "swagger2json", "package_url": "https://pypi.org/project/swagger2json/", "platform": "", "project_url": "https://pypi.org/project/swagger2json/", "project_urls": { "Homepage": "http://github.com/hhyo/swagger2json" }, "release_url": "https://pypi.org/project/swagger2json/0.1.1/", "requires_dist": null, "requires_python": "", "summary": "Generate request parameters from the Swagger json", "version": "0.1.1" }, "last_serial": 4986394, "releases": { "0.1.1": [ { "comment_text": "", "digests": { "md5": "9718f5b5f264deb6aa66b77fe227828b", "sha256": "fdf81c6b4f66bb43a8838d44a7ef12caeb9ed13e9567cb364f0064e73cb093bc" }, "downloads": -1, "filename": "swagger2json-0.1.1.tar.gz", "has_sig": false, "md5_digest": "9718f5b5f264deb6aa66b77fe227828b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6372, "upload_time": "2019-03-26T07:38:45", "url": "https://files.pythonhosted.org/packages/57/8a/23326aa9b7d110321c16d1abd82968ee3462feac6354846f5f9a89a9a8ea/swagger2json-0.1.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "9718f5b5f264deb6aa66b77fe227828b", "sha256": "fdf81c6b4f66bb43a8838d44a7ef12caeb9ed13e9567cb364f0064e73cb093bc" }, "downloads": -1, "filename": "swagger2json-0.1.1.tar.gz", "has_sig": false, "md5_digest": "9718f5b5f264deb6aa66b77fe227828b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6372, "upload_time": "2019-03-26T07:38:45", "url": "https://files.pythonhosted.org/packages/57/8a/23326aa9b7d110321c16d1abd82968ee3462feac6354846f5f9a89a9a8ea/swagger2json-0.1.1.tar.gz" } ] }