Skip to main content

Validation of Swagger specifications

Project description

# swagger_spec_validator
[![Build Status](https://travis-ci.org/Yelp/swagger_spec_validator.svg?branch=master)](https://travis-ci.org/Yelp/swagger_spec_validator)
[![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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

swagger-spec-validator-2.0.4.tar.gz (15.3 kB view details)

Uploaded Source

File details

Details for the file swagger-spec-validator-2.0.4.tar.gz.

File metadata

File hashes

Hashes for swagger-spec-validator-2.0.4.tar.gz
Algorithm Hash digest
SHA256 869930c23459a40aa425a61f60883663d92c000d1e7e8b4441e2bc54d3a71a0e
MD5 3f0a6c46d7053f4ae0ce2238a24333a3
BLAKE2b-256 f145f0d42353cafc5da7ea61e8de36cc159dc6e7a1a14437e4c904af2f790730

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page