Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Yelp/swagger_spec_validator

Last synced: about 1 month ago
JSON representation

Host: GitHub
URL: https://github.com/Yelp/swagger_spec_validator
Owner: Yelp
License: other
Created: 2015-01-05T23:40:39.000Z (almost 10 years ago)
Default Branch: master
Last Pushed: 2024-06-27T17:42:30.000Z (6 months ago)
Last Synced: 2024-08-01T22:56:10.709Z (4 months ago)
Language: Python
Homepage:
Size: 337 KB
Stars: 103
Watchers: 17
Forks: 71
Open Issues: 26
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.rst
- License: LICENSE.txt

Awesome Lists containing this project

starred-awesome - swagger_spec_validator - (Python)

README

        # swagger\_spec\_validator

[![Build Status](https://github.com/Yelp/swagger_spec_validator/workflows/build/badge.svg?branch=master)](https://github.com/Yelp/swagger_spec_validator/actions?query=workflow%3Abuild)

[![Coverage Status](https://coveralls.io/repos/Yelp/swagger_spec_validator/badge.svg)](https://coveralls.io/r/Yelp/swagger_spec_validator)

[![Latest Version](https://img.shields.io/pypi/v/swagger_spec_validator.svg)](https://pypi.python.org/pypi/swagger_spec_validator/)

## About

Swagger Spec Validator is a Python library that validates Swagger Specs against the [Swagger 1.2](https://github.com/swagger-api/swagger-spec/blob/master/versions/1.2.md) or [Swagger 2.0](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md) specification.  The validator aims to check for full compliance with the Specification.

## Example Usage

Validate a spec from a url:

```python

from swagger_spec_validator import validate_spec_url

# example for swagger spec v1.2

validate_spec_url('http://petstore.swagger.io/api/api-docs')

# example for swagger spec v2.0

validate_spec_url('http://petstore.swagger.io/v2/swagger.json')

```

## Documentation

More documentation is available at http://swagger_spec_validator.readthedocs.org

## Installation

    $ pip install swagger_spec_validator

## Contributing

1. Fork it ( http://github.com/Yelp/swagger_spec_validator/fork )

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create new Pull Request

## License

Copyright (c) 2015, Yelp, Inc. All rights reserved.

Apache v2