Library for accessing Swagger-enabled API's
Project description
Bravado
About
Bravado is a Yelp maintained fork of digium/swagger-py for use with OpenAPI Specification (previously known as Swagger).
From the OpenAPI Specification project:
The goal of The OpenAPI Specification is to define a standard, language-agnostic interface to REST APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection.
Client libraries can automatically be generated from the OpenAPI specification, however Bravado aims to be a complete replacement for code generation (swagger-codegen).
Example Usage
from bravado.client import SwaggerClient
client = SwaggerClient.from_url('http://petstore.swagger.io/v2/swagger.json')
pet = client.pet.getPetById(petId=42).result()Example with Basic Authentication
from bravado.requests_client import RequestsClient
from bravado.client import SwaggerClient
http_client = RequestsClient()
http_client.set_basic_auth(
'api.yourhost.com',
'username', 'password'
)
client = SwaggerClient.from_url(
'http://petstore.swagger.io/v2/swagger.json',
http_client=http_client,
)
pet = client.pet.getPetById(petId=42).result()Example with Header Authentication
from bravado.requests_client import RequestsClient
from bravado.client import SwaggerClient
http_client = RequestsClient()
http_client.set_api_key(
'api.yourhost.com', 'token'
param_name='api_key', param_in='header'
)
client = SwaggerClient.from_url(
'http://petstore.swagger.io/v2/swagger.json',
http_client=http_client,
)
pet = client.pet.getPetById(petId=42).result()Example with Fido Client (Async Http Client)
# Install bravado with fido extra (``pip install bravado[fido]``)
from bravado.fido_client import FidoClient
from bravado.client import SwaggerClient
http_client = FidoClient()
client = SwaggerClient.from_url(
'http://petstore.swagger.io/v2/swagger.json',
http_client=http_client,
)
pet = client.pet.getPetById(petId=42).result()Documentation
More documentation is available at http://bravado.readthedocs.org
Installation
# To install bravado with Synchronous Http Client only.
$ pip install bravado
# To install bravado with Synchronous and Asynchronous Http Client (RequestsClient and FidoClient).
$ pip install bravado[fido]Development
Code is documented using Sphinx.
virtualenv. is recommended to keep dependencies and libraries isolated.
Setup
# Run tests
tox
# Install git pre-commit hooks
tox -e pre-commit installContributing
Fork it ( http://github.com/Yelp/bravado/fork )
Create your feature branch (git checkout -b my-new-feature)
Add your modifications
Add short summary of your modifications on CHANGELOG-MASTER.rst
Commit your changes (git commit -m "Add some feature")
Push to the branch (git push origin my-new-feature)
Create new Pull Request
License
Copyright (c) 2013, Digium, Inc. All rights reserved. Copyright (c) 2014-2015, Yelp, Inc. All rights reserved.
Bravado is licensed with a BSD 3-Clause License.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file bravado-9.0.7.tar.gz.
File metadata
- Download URL: bravado-9.0.7.tar.gz
- Upload date:
- Size: 18.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a4bb19059387a76422cf09dd30da4e53b70af6f75550dafe298dc97e53dad647 |
|
| MD5 | a06b2916798f5ba5892efb4c2439d323 |
|
| BLAKE2b-256 | aa5a5ad9adc28841e4bb708ca7388edf86e3f87b69aab4202c5ab9ef46c76140 |
