{ "info": { "author": "Zalando SE", "author_email": "", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Intended Audience :: Developers", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5" ], "description": "===========================================\nLinter for Zalando's RESTful API Guidelines\n===========================================\n\n.. image:: https://travis-ci.org/zalando-incubator/restful-api-guidelines-linter.svg?branch=master\n :target: https://travis-ci.org/zalando-incubator/restful-api-guidelines-linter\n :alt: Build Status\n\n.. image:: https://coveralls.io/repos/zalando-incubator/restful-api-guidelines-linter/badge.svg\n :target: https://coveralls.io/r/zalando-incubator/restful-api-guidelines-linter\n :alt: Code Coverage\n\n.. image:: https://img.shields.io/pypi/dw/restful-api-guidelines-linter.svg\n :target: https://pypi.python.org/pypi/restful-api-guidelines-linter/\n :alt: PyPI Downloads\n\n.. image:: https://img.shields.io/pypi/v/restful-api-guidelines-linter.svg\n :target: https://pypi.python.org/pypi/restful-api-guidelines-linter/\n :alt: Latest PyPI version\n\n.. image:: https://img.shields.io/pypi/l/restful-api-guidelines-linter.svg\n :target: https://pypi.python.org/pypi/restful-api-guidelines-linter/\n :alt: License\n\n\nThis is a very basic linter to check whether a given Swagger specification (YAML file)\ncomplies with `Zalando's RESTful API Guidelines`_.\n\nUsage:\n\n.. code-block:: bash\n\n $ sudo pip3 install -U restful-api-guidelines-linter\n $ restful-api-guidelines-linter my-swagger-spec.yaml -v\n\nThe following guidelines are currently checked:\n\n* `Must: Always Return JSON Objects As Top-Level Data Structures To Support Extensibility `_\n* `Must: Avoid Trailing Slashes `_\n* `Must: Do Not Use URI Versioning `_\n* `Must: Pluralize Resource Names `_\n* `Must: Property names must be snake_case (and never camelCase). `_\n* `Must: Use HTTP Methods Correctly `_\n* `Must: Use lowercase separate words with hyphens for Path Segments `_\n* `Must: Use snake_case (never camelCase) for Query Parameters `_\n\n\nRunning Unit Tests\n==================\n\n.. code-block:: bash\n\n $ sudo pip3 install -U tox\n $ tox\n\n.. _Zalando's RESTful API Guidelines: http://zalando.github.io/restful-api-guidelines/\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/zalando-incubator/restful-api-guidelines-linter", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "restful-api-guidelines-linter", "package_url": "https://pypi.org/project/restful-api-guidelines-linter/", "platform": "", "project_url": "https://pypi.org/project/restful-api-guidelines-linter/", "project_urls": { "Homepage": "https://github.com/zalando-incubator/restful-api-guidelines-linter" }, "release_url": "https://pypi.org/project/restful-api-guidelines-linter/0.2/", "requires_dist": null, "requires_python": "", "summary": "", "version": "0.2" }, "last_serial": 2468908, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "f12fa85d7d32d2de6a91c9f438dd45de", "sha256": "17cf3c42e93100af40e0fc3644dff4c3b73ac2d4a755915b99327d18c45e1436" }, "downloads": -1, "filename": "restful_api_guidelines_linter-0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "f12fa85d7d32d2de6a91c9f438dd45de", "packagetype": "bdist_wheel", "python_version": "3.5", "requires_python": null, "size": 7157, "upload_time": "2016-11-18T16:43:18", "url": "https://files.pythonhosted.org/packages/66/49/28f3b461a195f950d04ecfc34e587f517e46bf5e187a89848fcb64444df2/restful_api_guidelines_linter-0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "a03612aa62e22d840caf8e7d81fb0fb1", "sha256": "4209671fcaeb0b813e86724cfaa82bd11cc8dc6481f0a96ea3824338f16e946f" }, "downloads": -1, "filename": "restful-api-guidelines-linter-0.1.tar.gz", "has_sig": false, "md5_digest": "a03612aa62e22d840caf8e7d81fb0fb1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4761, "upload_time": "2016-11-18T16:43:15", "url": "https://files.pythonhosted.org/packages/d8/36/e88228831b8f91d5dfeade3b342fbaad2c4355bda023c692efd650657039/restful-api-guidelines-linter-0.1.tar.gz" } ], "0.2": [ { "comment_text": "", "digests": { "md5": "5581f2415df1afcf4ca5752d000c38c3", "sha256": "c76a824d564993816ba62085a3481c98d227931a5fecc727e22643eea1960748" }, "downloads": -1, "filename": "restful_api_guidelines_linter-0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "5581f2415df1afcf4ca5752d000c38c3", "packagetype": "bdist_wheel", "python_version": "3.5", "requires_python": null, "size": 7498, "upload_time": "2016-11-18T16:48:08", "url": "https://files.pythonhosted.org/packages/ad/2d/27c7ef71ff2d8539ba11a9a5ff72e64b0d81a06119b625710948c95405c0/restful_api_guidelines_linter-0.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "b45da60c67bd9915a614fcb2a0f6c797", "sha256": "409ef746e38820a37497f09339c1a7902def9fe67d5635e7a918935b36158b02" }, "downloads": -1, "filename": "restful-api-guidelines-linter-0.2.tar.gz", "has_sig": false, "md5_digest": "b45da60c67bd9915a614fcb2a0f6c797", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4996, "upload_time": "2016-11-18T16:48:06", "url": "https://files.pythonhosted.org/packages/d9/51/961fe5bd5665311ad81b2263efc10658cc921f2d5c6485f16409d6f384c4/restful-api-guidelines-linter-0.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "5581f2415df1afcf4ca5752d000c38c3", "sha256": "c76a824d564993816ba62085a3481c98d227931a5fecc727e22643eea1960748" }, "downloads": -1, "filename": "restful_api_guidelines_linter-0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "5581f2415df1afcf4ca5752d000c38c3", "packagetype": "bdist_wheel", "python_version": "3.5", "requires_python": null, "size": 7498, "upload_time": "2016-11-18T16:48:08", "url": "https://files.pythonhosted.org/packages/ad/2d/27c7ef71ff2d8539ba11a9a5ff72e64b0d81a06119b625710948c95405c0/restful_api_guidelines_linter-0.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "b45da60c67bd9915a614fcb2a0f6c797", "sha256": "409ef746e38820a37497f09339c1a7902def9fe67d5635e7a918935b36158b02" }, "downloads": -1, "filename": "restful-api-guidelines-linter-0.2.tar.gz", "has_sig": false, "md5_digest": "b45da60c67bd9915a614fcb2a0f6c797", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4996, "upload_time": "2016-11-18T16:48:06", "url": "https://files.pythonhosted.org/packages/d9/51/961fe5bd5665311ad81b2263efc10658cc921f2d5c6485f16409d6f384c4/restful-api-guidelines-linter-0.2.tar.gz" } ] }