{
"info": {
"author": "Ayaka Shimada",
"author_email": "aya.a.shimada@gmail.com",
"bugtrack_url": null,
"classifiers": [],
"description": "\n\n\n[](https://travis-ci.com/hakopako/openapi-cli-tool)\n
\n
\n
\n\n# openapi-cli-tool\nOpenAPI (Swagger 3.x) CLI Tool. \n\n- Supports multiple file extensions (json|yaml|yml).\n- Can list up defined API paths.\n- Display an API specification which is resolved (`$ref`).\n- Bundle multi-file into one (output to json|yaml|html).\n- OAS interactive scaffolding. \n\n# Requirements\n\nPython 2.7, 3.4 <=.\n\n# Installation\n\nWith pip:\n\n```bash\n$ pip install openapi-cli-tool\n```\nManually: \nClone the repository and execute the Python installation command on your machine. \n\n```bash\n$ pip -r requirements.txt install\n$ python setup.py install\n```\n\nThen `openapi-cli-tool` command is installed.\n\n# Usage\n\n```\n$ openapi-cli-tool --help\nUsage: openapi-cli-tool [OPTIONS] COMMAND [ARGS]...\n\nOptions:\n --help Show this message and exit.\n\nCommands:\n bundle Bundle multiple files into one.\n list List up API paths in a file or directory.\n resolve Display `$ref` resolved API specification.\n scaffold Interactively create a simple OpenAPI Specification.\n```\n\n## Bundle\n\nBundle multi-file specifications into one, regardless of file extension (json|yaml|yml).\n\n```\n$ openapi-cli-tool bundle --help\nUsage: openapi-cli-tool bundle [OPTIONS] FILE_PATHS\n\n Bundle multiple files into one.\n\nOptions:\n -f, --file TEXT Load common objects such as info and servers from a\n specific file. Default is a file which is the top of list\n command result.\n -t, --type TEXT Export data type. {json|yaml|html} [default: json]\n --help Show this message and exit.\n```\n\nexample:\n```\n$ openapi-cli-tool bundle -t html file1.json file2.yaml` > ./specification.html\n```\n\nIn the html file, an unpkg version of [swagger-ui](https://github.com/swagger-api/swagger-ui) is embedded. Rendered screenshot below: \n\n\n\n\n\n## List\n\nList up API paths from a file/directory regardless of the file extension (json|yaml|yml).\n\n```bash\n$ openapi-cli-tool list `find ./spec`\n\nMethod Path File\n-------- --------- ------------------------------------------\nPUT /avatar ./tests/resources/spec/sample.yml\nGET /follwers ./tests/resources/spec/folder1/sample2.yaml\nPOST /follwers ./tests/resources/spec/folder1/sample2.yaml\nPUT /follwers ./tests/resources/spec/folder1/sample2.yaml\nPOST /pets ./tests/resources/spec/sample.yml\nGET /posts ./tests/resources/spec/folder1/sample.json\nPOST /posts ./tests/resources/spec/folder1/sample.json\nGET /users ./tests/resources/spec/folder1/sample.json\nPOST /users ./tests/resources/spec/folder1/sample.json\n```\n\n\n## Resolve\n\nDisplay an API specification which is resolved from a multi-file API specification via $ref pointers. \n\n```\nUsage: openapi-cli-tool resolve [OPTIONS] METHOD PATH FILE_PATHS\n\n Display `$ref` resolved API specification.\n\nOptions:\n -t, --type TEXT Export data type. {json|yaml} [default: json]\n --help Show this message and exit.\n```\n\nexample:\n```bash\n$ openapi-cli-tool resolve post /cats `find ./tests/resources/spec`\n```\n\n\n## Scaffold\n\nInteractively input information of your API. \nA simple OpenAPI Specification is generated from your prompt.\n\n```bash\n$ openapi-cli-tool scaffold\n\nPlease enter title [\"\"]: sample\nPlease enter version [v1.0]:\nPlease enter license [Apache 2.0]:\nPlease enter server url [http://example.com]:\nPlease enter path [/]: /example\nPlease enter method for /example [get|post|put|delete|head|option|trace]: get\nPlease enter description for get /example [\"\"]: sample get endpoint\nPlease enter response code for get /example [200]:\n```\n\n\n",
"description_content_type": "text/markdown",
"docs_url": null,
"download_url": "",
"downloads": {
"last_day": -1,
"last_month": -1,
"last_week": -1
},
"home_page": "https://github.com/hakopako/openapi-cli-tool",
"keywords": "",
"license": "MIT",
"maintainer": "",
"maintainer_email": "",
"name": "openapi-cli-tool",
"package_url": "https://pypi.org/project/openapi-cli-tool/",
"platform": "",
"project_url": "https://pypi.org/project/openapi-cli-tool/",
"project_urls": {
"Homepage": "https://github.com/hakopako/openapi-cli-tool"
},
"release_url": "https://pypi.org/project/openapi-cli-tool/0.3.0/",
"requires_dist": [
"click (==7.0)",
"pyyaml (==5.1)",
"tabulate (==0.8.3)"
],
"requires_python": "",
"summary": "openapi cli tool",
"version": "0.3.0",
"yanked": false,
"yanked_reason": null
},
"last_serial": 6293690,
"releases": {
"0.1.2": [
{
"comment_text": "",
"digests": {
"md5": "f957f7225d235733885edcfcc928e796",
"sha256": "8cc1c1e91e9cde634377430f630a2ced807a974379ea3900def36a8ef531d690"
},
"downloads": -1,
"filename": "openapi_cli_tool-0.1.2-py2-none-any.whl",
"has_sig": false,
"md5_digest": "f957f7225d235733885edcfcc928e796",
"packagetype": "bdist_wheel",
"python_version": "py2",
"requires_python": null,
"size": 9430,
"upload_time": "2019-06-10T15:57:45",
"upload_time_iso_8601": "2019-06-10T15:57:45.988869Z",
"url": "https://files.pythonhosted.org/packages/be/86/7c0cc8d6c2d671ec0f662b94084cc8255a57ab37467b6003b0880f988fc8/openapi_cli_tool-0.1.2-py2-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "fd5541a7ad51629adbc77657405a4c7e",
"sha256": "211ea58c66f7dfd918d239fe54308e8f5168d15478615a5123704593196c2ee1"
},
"downloads": -1,
"filename": "openapi_cli_tool-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fd5541a7ad51629adbc77657405a4c7e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 9430,
"upload_time": "2019-06-10T15:57:26",
"upload_time_iso_8601": "2019-06-10T15:57:26.275766Z",
"url": "https://files.pythonhosted.org/packages/89/6f/e6b6fa0ce4210b5896340722e103193807a434f0b9ed6481229a82d95bcd/openapi_cli_tool-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "55cf6feda7bafff9137fd3d215e56cea",
"sha256": "2020eed96ca70ed87b83e8039f8ebb340c9fd1715330eddd0b1b26c2edf78945"
},
"downloads": -1,
"filename": "openapi-cli-tool-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "55cf6feda7bafff9137fd3d215e56cea",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5774,
"upload_time": "2019-06-10T15:57:27",
"upload_time_iso_8601": "2019-06-10T15:57:27.332421Z",
"url": "https://files.pythonhosted.org/packages/ef/7e/0729add2d9af00835326beabfd5d5c242f84282fbec5116d7c18976ea01c/openapi-cli-tool-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"0.1.3": [
{
"comment_text": "",
"digests": {
"md5": "c97a8ee997abf3544b7ad80f3ce350c1",
"sha256": "22163bec0702fa8d553388bf193e45ba52206cb18318c8de121fe8c22f6378a6"
},
"downloads": -1,
"filename": "openapi_cli_tool-0.1.3-py2-none-any.whl",
"has_sig": false,
"md5_digest": "c97a8ee997abf3544b7ad80f3ce350c1",
"packagetype": "bdist_wheel",
"python_version": "py2",
"requires_python": null,
"size": 10414,
"upload_time": "2019-06-23T15:01:45",
"upload_time_iso_8601": "2019-06-23T15:01:45.923706Z",
"url": "https://files.pythonhosted.org/packages/ac/9b/74bde8ad557aa7910d93d0c0a4b5cdb7b0e44857147a7bc6f6a26933c3ca/openapi_cli_tool-0.1.3-py2-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "e9a7b0ec221239e3191fc514e2358260",
"sha256": "7c98210d84e00d8380fb889ae6bafad4f586f2eb429623be535b3e16c367bd52"
},
"downloads": -1,
"filename": "openapi_cli_tool-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e9a7b0ec221239e3191fc514e2358260",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 10413,
"upload_time": "2019-06-23T15:01:28",
"upload_time_iso_8601": "2019-06-23T15:01:28.546820Z",
"url": "https://files.pythonhosted.org/packages/87/19/d3b1ea8803c967f07eff2547c4233f80833830ce561e84b8144590f6c04d/openapi_cli_tool-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "b49a97fc08a28e89ae913a4ac8cd17cc",
"sha256": "431c3732733212f2c70808813b38358ac2351b41f6ae357937eccfdef2dd1da8"
},
"downloads": -1,
"filename": "openapi-cli-tool-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "b49a97fc08a28e89ae913a4ac8cd17cc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6247,
"upload_time": "2019-06-23T15:01:29",
"upload_time_iso_8601": "2019-06-23T15:01:29.958588Z",
"url": "https://files.pythonhosted.org/packages/c7/41/fd15d41233f6d3f1fea785acfbab01f4d87a8425bad868332c2279f5efed/openapi-cli-tool-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"0.1a0": [
{
"comment_text": "",
"digests": {
"md5": "8e6904492d7a24cc501d7e6715372361",
"sha256": "21f9d0e7108980babb2e6b74c27b0878df355e80771c21e060086b7569e7407f"
},
"downloads": -1,
"filename": "openapi_cli_tool-0.1a0-py2-none-any.whl",
"has_sig": false,
"md5_digest": "8e6904492d7a24cc501d7e6715372361",
"packagetype": "bdist_wheel",
"python_version": "py2",
"requires_python": null,
"size": 9432,
"upload_time": "2019-06-10T15:43:01",
"upload_time_iso_8601": "2019-06-10T15:43:01.387575Z",
"url": "https://files.pythonhosted.org/packages/91/37/ef81e98d69d3f2a66683f00bdfb68807f871355c12667460143fa89864ec/openapi_cli_tool-0.1a0-py2-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "cf60dea8f08771171df327907d3d0c9a",
"sha256": "1f5b3746265deb856a424cabfb8510f53cd81932d76d42d64de2e34e0bdf7add"
},
"downloads": -1,
"filename": "openapi_cli_tool-0.1a0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cf60dea8f08771171df327907d3d0c9a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 9431,
"upload_time": "2019-06-10T15:43:16",
"upload_time_iso_8601": "2019-06-10T15:43:16.236387Z",
"url": "https://files.pythonhosted.org/packages/26/27/5c053dd4669f6c402eaf220af3c87cd8afea8ad56a9715e8c464f0b8701e/openapi_cli_tool-0.1a0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "c68fa3044719935569ec5666ebae5285",
"sha256": "ed485bbca43130b36431c022e1399ab6e5c6736391b1c9884d7a92f18bba8a70"
},
"downloads": -1,
"filename": "openapi-cli-tool-0.1a0.tar.gz",
"has_sig": false,
"md5_digest": "c68fa3044719935569ec5666ebae5285",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5772,
"upload_time": "2019-06-10T15:43:02",
"upload_time_iso_8601": "2019-06-10T15:43:02.630938Z",
"url": "https://files.pythonhosted.org/packages/74/57/0f35b9b30b1d532fed4d8ab50989b4aef95851309bade1b9e079fd134552/openapi-cli-tool-0.1a0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"0.2.0": [
{
"comment_text": "",
"digests": {
"md5": "c0f08f99a2fc5276a8d7298933b7247a",
"sha256": "509d0af3dd82939a466fc444d774bac98a99d1ef4a3f51f938b278b0bb469d29"
},
"downloads": -1,
"filename": "openapi_cli_tool-0.2.0-py2-none-any.whl",
"has_sig": false,
"md5_digest": "c0f08f99a2fc5276a8d7298933b7247a",
"packagetype": "bdist_wheel",
"python_version": "py2",
"requires_python": null,
"size": 10539,
"upload_time": "2019-10-02T20:51:43",
"upload_time_iso_8601": "2019-10-02T20:51:43.458971Z",
"url": "https://files.pythonhosted.org/packages/8d/c5/72b27db90e492454e99c06537804e58814415eb70ce522d2dee598049fae/openapi_cli_tool-0.2.0-py2-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "a8c8eb35a5f74a3d97a8c97867c8efdd",
"sha256": "6ac7e7b5236729cbf4fb85a6b9f31eff42744f47b14e2543c77004130575802b"
},
"downloads": -1,
"filename": "openapi_cli_tool-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a8c8eb35a5f74a3d97a8c97867c8efdd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 10536,
"upload_time": "2019-10-02T20:51:42",
"upload_time_iso_8601": "2019-10-02T20:51:42.036102Z",
"url": "https://files.pythonhosted.org/packages/9c/bb/d97ba1d4eb7ce8ac880bcc936492f2f20b48e9fd38f33d455c2cc3b6c29e/openapi_cli_tool-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "92f8f431e15473b471ba030c04a0bac6",
"sha256": "b1c104a11e65a75ed24a15ea5382df36758aaf041cc7eb7cb6612bf1f9e82170"
},
"downloads": -1,
"filename": "openapi-cli-tool-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "92f8f431e15473b471ba030c04a0bac6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7335,
"upload_time": "2019-10-02T20:51:43",
"upload_time_iso_8601": "2019-10-02T20:51:43.640713Z",
"url": "https://files.pythonhosted.org/packages/18/7f/899e698ed2f0c375febcafe7d3f8a31a16858230776c87cafc50939de707/openapi-cli-tool-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"0.2.1": [
{
"comment_text": "",
"digests": {
"md5": "0c04bea506663b41b81a1a1e9d76f060",
"sha256": "d7049cd442add6f64c2db6dfc89699653a0177f50a390fe8af4c61f0b6a9c95b"
},
"downloads": -1,
"filename": "openapi_cli_tool-0.2.1-py2-none-any.whl",
"has_sig": false,
"md5_digest": "0c04bea506663b41b81a1a1e9d76f060",
"packagetype": "bdist_wheel",
"python_version": "py2",
"requires_python": null,
"size": 10538,
"upload_time": "2019-10-30T19:00:34",
"upload_time_iso_8601": "2019-10-30T19:00:34.834530Z",
"url": "https://files.pythonhosted.org/packages/51/c2/fc3af6ba26310d96a0a38623e20ab9c57c147692c085893452472006da8d/openapi_cli_tool-0.2.1-py2-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "301494447b86971ba0c69a3fdfb691ce",
"sha256": "3b142eb68bfa032d6daba48c93ad9db5c950ee2b8948afed7c03c5dcbcc2ac88"
},
"downloads": -1,
"filename": "openapi_cli_tool-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "301494447b86971ba0c69a3fdfb691ce",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 10535,
"upload_time": "2019-10-30T19:00:46",
"upload_time_iso_8601": "2019-10-30T19:00:46.515463Z",
"url": "https://files.pythonhosted.org/packages/c9/2a/94e57accaedf1db779267138a16f44dbfd2b16fab5fd0466c8eb80343a1a/openapi_cli_tool-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "35ff85bf1c37f2b9f9295038ad0232e1",
"sha256": "502c2d0b5463062859ae6f02de4e030c097073cc4e1bc54caffc7e7e847379a9"
},
"downloads": -1,
"filename": "openapi-cli-tool-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "35ff85bf1c37f2b9f9295038ad0232e1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7338,
"upload_time": "2019-10-30T19:00:36",
"upload_time_iso_8601": "2019-10-30T19:00:36.354793Z",
"url": "https://files.pythonhosted.org/packages/9e/a9/795f8731dbfd065f080c232a68762efd61a75a8b3ffea45dbb979043e585/openapi-cli-tool-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"0.3.0": [
{
"comment_text": "",
"digests": {
"md5": "4a3f3adb052089830364fe40b8e88cdd",
"sha256": "895f43bf06a707cdd1e4ebef1f380c7c0c235cfedad93239d9e0bd29768c868d"
},
"downloads": -1,
"filename": "openapi_cli_tool-0.3.0-py2-none-any.whl",
"has_sig": false,
"md5_digest": "4a3f3adb052089830364fe40b8e88cdd",
"packagetype": "bdist_wheel",
"python_version": "py2",
"requires_python": null,
"size": 11068,
"upload_time": "2019-12-13T15:21:38",
"upload_time_iso_8601": "2019-12-13T15:21:38.923829Z",
"url": "https://files.pythonhosted.org/packages/86/a7/c0969568612c4f838838d0a73fb4ae9c8e626945a76bad504ad0df157c26/openapi_cli_tool-0.3.0-py2-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "9ae3b666b5c5c0e63db8eb2051241777",
"sha256": "612ad09dad429fea783fd636453ed0d2ac1abb589d74efef1df2ad78de5b9f30"
},
"downloads": -1,
"filename": "openapi_cli_tool-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9ae3b666b5c5c0e63db8eb2051241777",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 11067,
"upload_time": "2019-12-13T15:21:40",
"upload_time_iso_8601": "2019-12-13T15:21:40.081125Z",
"url": "https://files.pythonhosted.org/packages/46/31/60bc7f835ef5231baac94b5ac90fd61956d60e92a696a82122567cd38910/openapi_cli_tool-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "1b1a68d745f6f57848798f7412b13d4f",
"sha256": "4f9bd88cc0737ee395b25bf5821e3f85236871da9c1a696bd36a3afdd6ff882a"
},
"downloads": -1,
"filename": "openapi-cli-tool-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "1b1a68d745f6f57848798f7412b13d4f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7740,
"upload_time": "2019-12-13T15:21:40",
"upload_time_iso_8601": "2019-12-13T15:21:40.494783Z",
"url": "https://files.pythonhosted.org/packages/53/17/53bd32842cac710fa1a7956044eec745251fa9f81e99bddfa99b9e6e1ac3/openapi-cli-tool-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
]
},
"urls": [
{
"comment_text": "",
"digests": {
"md5": "4a3f3adb052089830364fe40b8e88cdd",
"sha256": "895f43bf06a707cdd1e4ebef1f380c7c0c235cfedad93239d9e0bd29768c868d"
},
"downloads": -1,
"filename": "openapi_cli_tool-0.3.0-py2-none-any.whl",
"has_sig": false,
"md5_digest": "4a3f3adb052089830364fe40b8e88cdd",
"packagetype": "bdist_wheel",
"python_version": "py2",
"requires_python": null,
"size": 11068,
"upload_time": "2019-12-13T15:21:38",
"upload_time_iso_8601": "2019-12-13T15:21:38.923829Z",
"url": "https://files.pythonhosted.org/packages/86/a7/c0969568612c4f838838d0a73fb4ae9c8e626945a76bad504ad0df157c26/openapi_cli_tool-0.3.0-py2-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "9ae3b666b5c5c0e63db8eb2051241777",
"sha256": "612ad09dad429fea783fd636453ed0d2ac1abb589d74efef1df2ad78de5b9f30"
},
"downloads": -1,
"filename": "openapi_cli_tool-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9ae3b666b5c5c0e63db8eb2051241777",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 11067,
"upload_time": "2019-12-13T15:21:40",
"upload_time_iso_8601": "2019-12-13T15:21:40.081125Z",
"url": "https://files.pythonhosted.org/packages/46/31/60bc7f835ef5231baac94b5ac90fd61956d60e92a696a82122567cd38910/openapi_cli_tool-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "1b1a68d745f6f57848798f7412b13d4f",
"sha256": "4f9bd88cc0737ee395b25bf5821e3f85236871da9c1a696bd36a3afdd6ff882a"
},
"downloads": -1,
"filename": "openapi-cli-tool-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "1b1a68d745f6f57848798f7412b13d4f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7740,
"upload_time": "2019-12-13T15:21:40",
"upload_time_iso_8601": "2019-12-13T15:21:40.494783Z",
"url": "https://files.pythonhosted.org/packages/53/17/53bd32842cac710fa1a7956044eec745251fa9f81e99bddfa99b9e6e1ac3/openapi-cli-tool-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"vulnerabilities": []
}