{ "info": { "author": "Cyprien Guillemot", "author_email": "cyprien.guillemot@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Natural Language :: English", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4" ], "description": ".. image:: https://travis-ci.org/Trax-air/swagger-aggregator.svg?branch=master\n :alt: Travis status\n :target: https://travis-ci.org/Trax-air/swagger-aggregator\n\nswagger-aggregator\n==================\n\nSwagger-aggregator allow you to create a swagger REST API from several other swagger REST APIs.\n\nThis can be really useful if you want to make an API Gateway accessing some of your internal APIs.\nYou can also filter which path you want to deliver, and which properties of your definitions you don't want to show.\n\nExample Usage\n-------------\n\nHere is an example of an aggregate configuration.\n\n.. code:: yaml\n\n args: pet_url\n\n info:\n version: \"0.1\"\n title: \"API Gateway\"\n\n basePath: /v2\n\n apis:\n pet: http://pet_url/v2\n\n exclude_paths:\n - DELETE /pets/{petId}\n\n exclude_fields:\n petPet:\n - id\n\nThis is not the most useful aggregation, as it only aggregate one API.\nThe first part, `args`, define that the first parameter we will send to the aggregate will be pet_url. Then pet_url will be replaced by the given value everywhere in the config.\nThe two next part, `info` and `basePath`, are the same as the ones you can find in every swagger API.\n`apis`, define the different APIs you want to aggregate. A name is associated with it URL.\nThen `exclude_paths` allow you to not deliver some path. In this case we don't want the user to delete a pet.\n\nFinally, `exclude_fields` define the attributes of the definitions we do not want to show.\nThe value of the keys is the name of the API followed by the name of the definition. The value of each key will be a list of all properties to exclude.\n\nThen use this command to generate the aggregated swagger file:\n\n.. code:: python\n\n from traxit_aggregator import SwaggerAggregator\n\n SwaggerAggregator('config.yaml', 'pet.com')\n\nDocumentation\n-------------\n\nMore documentation is available at https://swagger-aggregator.readthedocs.org/en/latest/.\n\nSetup\n-----\n\n`make install` or `pip install swagger-aggregator`\n\nLicense\n-------\n\nswagger-aggregator is licensed under http://opensource.org/licenses/MIT.\n\n\n=======\nHistory\n=======\n\n0.1.1 (2016-1-31)\n------------------\n\n* Change license to MIT.\n\n0.1 (2016-1-29)\n------------------\n\n* First release on PyPI.", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/Trax-air/swagger-aggregator", "keywords": "swagger,aggregator,API,REST,swagger-aggregator", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "swagger-aggregator", "package_url": "https://pypi.org/project/swagger-aggregator/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/swagger-aggregator/", "project_urls": { "Homepage": "https://github.com/Trax-air/swagger-aggregator" }, "release_url": "https://pypi.org/project/swagger-aggregator/0.1.1/", "requires_dist": [ "flask (==0.10.1)", "requests (>=1.8.1)", "shortuuid (==0.4.3)", "swagger-parser (==0.1)", "simplejson (==3.8.1)", "PyYAML (==3.11)" ], "requires_python": "", "summary": "Aggregate several swagger APIs in one", "version": "0.1.1" }, "last_serial": 1932219, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "d86a99d499eae5da5e656a7a54e505a2", "sha256": "2f38fefec23ab4e5a029d851d9fe4a70660bca038dcf8f3938d8a9781ea6e3b0" }, "downloads": -1, "filename": "swagger_aggregator-0.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "d86a99d499eae5da5e656a7a54e505a2", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 8578, "upload_time": "2016-01-29T14:38:28", "url": "https://files.pythonhosted.org/packages/65/bd/ddeb86d16e375a0fbde7f5e390ef52b1799b159eaac9bcad153fedcd426e/swagger_aggregator-0.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f0f318c1f349033efc8878aa78d5c71f", "sha256": "f4222c03ffb3eebf3f4f9f4be35545b46c037db54e426c5cf09462ca729b0533" }, "downloads": -1, "filename": "swagger_aggregator-0.1.tar.gz", "has_sig": false, "md5_digest": "f0f318c1f349033efc8878aa78d5c71f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 29256, "upload_time": "2016-01-29T14:38:45", "url": "https://files.pythonhosted.org/packages/62/8b/3afd82bf78b09025204e399ac9fc978cd430ee5adb13a5c22d4400b44ce0/swagger_aggregator-0.1.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "9f1ef2893f6a6e2bb5941357af54051f", "sha256": "f26c1fe417a3edd2c4cfae82af8e71c9b6e8c00fda441d179d75c9fdb7365e39" }, "downloads": -1, "filename": "swagger_aggregator-0.1.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "9f1ef2893f6a6e2bb5941357af54051f", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 8604, "upload_time": "2016-01-31T16:14:17", "url": "https://files.pythonhosted.org/packages/f1/7e/4f2d1ab5222397e07daa0587b9c4d65383cc602a87ccb1f8947126a0ed5a/swagger_aggregator-0.1.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "34e06ccd6261cc291e46a800ff7b04c2", "sha256": "0476f6be8e73654326affb7876f1e8a22de5058b2cc0145088edf021453105a6" }, "downloads": -1, "filename": "swagger_aggregator-0.1.1.tar.gz", "has_sig": false, "md5_digest": "34e06ccd6261cc291e46a800ff7b04c2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17071, "upload_time": "2016-01-31T16:14:24", "url": "https://files.pythonhosted.org/packages/db/89/bae159e9f5b2dee0ae72fa630f33b2425eacac27e83375f5ad45f5c7db2a/swagger_aggregator-0.1.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "9f1ef2893f6a6e2bb5941357af54051f", "sha256": "f26c1fe417a3edd2c4cfae82af8e71c9b6e8c00fda441d179d75c9fdb7365e39" }, "downloads": -1, "filename": "swagger_aggregator-0.1.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "9f1ef2893f6a6e2bb5941357af54051f", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 8604, "upload_time": "2016-01-31T16:14:17", "url": "https://files.pythonhosted.org/packages/f1/7e/4f2d1ab5222397e07daa0587b9c4d65383cc602a87ccb1f8947126a0ed5a/swagger_aggregator-0.1.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "34e06ccd6261cc291e46a800ff7b04c2", "sha256": "0476f6be8e73654326affb7876f1e8a22de5058b2cc0145088edf021453105a6" }, "downloads": -1, "filename": "swagger_aggregator-0.1.1.tar.gz", "has_sig": false, "md5_digest": "34e06ccd6261cc291e46a800ff7b04c2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17071, "upload_time": "2016-01-31T16:14:24", "url": "https://files.pythonhosted.org/packages/db/89/bae159e9f5b2dee0ae72fa630f33b2425eacac27e83375f5ad45f5c7db2a/swagger_aggregator-0.1.1.tar.gz" } ] }