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.1.0.tar.gz (15.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

swagger_spec_validator-2.1.0-py2.py3-none-any.whl (22.8 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

File hashes

Hashes for swagger-spec-validator-2.1.0.tar.gz
Algorithm Hash digest
SHA256 dc9219c6572ce0def6e1c160ca253c0e7fcde75812628f0c0199334f85bd138e
MD5 e13a79ab0a029e706058183e0e22db25
BLAKE2b-256 e32f3767da696617ee72190361805dff4bca68a611d4673de848857654789534

See more details on using hashes here.

File details

Details for the file swagger_spec_validator-2.1.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for swagger_spec_validator-2.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 aedacb6c6b475026a1b5ac218fb590382d08064e227da254eb961d17cfd2b7c1
MD5 bc8fb6e9f29bc36dc050330f7ac184db
BLAKE2b-256 4402bcc0122d561d9727b8ca476058f2c57a37a1c86d0f7c9aec5543f3219cd0

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