Library for accessing Swagger-enabled API's
Swagger.py is a Python library for using Swagger defined API’s.
Swagger itself is best described on the Swagger home page:
Swagger is a specification and complete framework implementation for describing, producing, consuming, and visualizing RESTful web services.
The Swagger specification defines how API’s may be described using Swagger.
Swagger.py also supports a WebSocket extension, allowing a WebSocket to be documented, and auto-generated WebSocket client code.
Install the latest release from PyPI.
$ sudo pip install swaggerpy
Or install from source using the setup.py script.
$ sudo ./setup.py install
Swagger.py will dynamically build an object model from a Swagger-enabled RESTful API.
Here is a simple example using the Asterisk REST Interface
#!/usr/bin/env python import json from swaggerpy.client import SwaggerClient from swaggerpy.http_client import SynchronousHttpClient http_client = SynchronousHttpClient() http_client.set_basic_auth('localhost', 'hey', 'peekaboo') ari = SwaggerClient( "http://localhost:8088/ari/api-docs/resources.json", http_client=http_client) ws = ari.events.eventWebsocket(app='hello') for msg_str in iter(lambda: ws.recv(), None): msg_json = json.loads(msg_str) if msg_json['type'] == 'StasisStart': channelId = msg_json['channel']['id'] ari.channels.answer(channelId=channelId) ari.channels.play(channelId=channelId, media='sound:hello-world') ari.channels.continueInDialplan(channelId=channelId)
There are the beginnings of a Mustache-based code generator, but it’s not functional… yet.
The data model presented by the swagger_model module is nearly identical to the original Swagger API resource listing and API declaration. This means that if you add extra custom metadata to your docs (such as a _author or _copyright field), they will carry forward into the object model. I recommend prefixing custom fields with an underscore, to avoid collisions with future versions of Swagger.
There are a few meaningful differences.
To keep things isolated, I also recommend installing (and using) virtualenv.
$ sudo pip install virtualenv $ mkdir -p ~/virtualenv $ virtualenv ~/virtualenv/swagger $ . ~/virtualenv/swagger/bin/activate
Setuptools is used for building. Nose is used for unit testing, with the coverage plugin installed to generated code coverage reports. Pass --with-coverage to generate the code coverage report. HTML versions of the reports are put in cover/index.html.
$ ./setup.py develop # prep for development (install deps, launchers, etc.) $ ./setup.py nosetests # run unit tests $ ./setup.py bdist_egg # build distributable
Copyright (c) 2013, Digium, Inc. All rights reserved.
Swagger.py is licensed with a BSD 3-Clause License.