Metadata-Version: 1.1
Name: restful-api-guidelines-linter
Version: 0.1
Summary: UNKNOWN
Home-page: https://github.com/zalando-incubator/restful-api-guidelines-linter
Author: Zalando SE
Author-email: UNKNOWN
License: UNKNOWN
Description: ===========================================
        Linter for Zalando's RESTful API Guidelines
        ===========================================
        
        This is a very basic linter to check whether a given Swagger specification (YAML file)
        complies with `Zalando's RESTful API Guidelines`_.
        
        Usage:
        
        .. code-block:: bash
        
            $ sudo pip3 install -r requirements.txt
            $ ./linter.py my-swagger-spec.yaml
        
        The following guidelines are currently checked:
        
        * `Must: Always Return JSON Objects As Top-Level Data Structures To Support Extensibility <https://zalando.github.io/restful-api-guidelines/compatibility/Compatibility.html#must-always-return-json-objects-as-toplevel-data-structures-to-support-extensibility>`_
        * `Must: Avoid Trailing Slashes <https://zalando.github.io/restful-api-guidelines/naming/Naming.html#must-avoid-trailing-slashes>`_
        * `Must: Do Not Use URI Versioning <https://zalando.github.io/restful-api-guidelines/compatibility/Compatibility.html#must-do-not-use-uri-versioning>`_
        * `Must: Pluralize Resource Names <https://zalando.github.io/restful-api-guidelines/naming/Naming.html#must-pluralize-resource-names>`_
        * `Must: Property names must be snake_case (and never camelCase). <http://zalando.github.io/restful-api-guidelines/json-guidelines/JsonGuidelines.html#must-property-names-must-be-snakecase-and-never-camelcase>`_
        * `Must: Use HTTP Methods Correctly <http://zalando.github.io/restful-api-guidelines/http/Http.html#must-use-http-methods-correctly>`_
        * `Must: Use lowercase separate words with hyphens for Path Segments <http://zalando.github.io/restful-api-guidelines/naming/Naming.html#must-use-lowercase-separate-words-with-hyphens-for-path-segments>`_
        * `Must: Use snake_case (never camelCase) for Query Parameters <http://zalando.github.io/restful-api-guidelines/naming/Naming.html#must-use-snakecase-never-camelcase-for-query-parameters>`_
        
        
        Running Unit Tests
        ==================
        
        .. code-block:: bash
        
            $ sudo pip3 install -U tox
            $ tox
        
        .. _Zalando's RESTful API Guidelines: http://zalando.github.io/restful-api-guidelines/
        
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
