Related Libraries

You may find related libraries to this one:

• https://github.com/Trax-air/swagger-tester: Auto-test your swagger API in your unit tests. All test calls are generated by your swagger file.

• https://github.com/Trax-air/swagger-aggregator: Aggregate several swagger specs into one. Useful for your API gateways!

• https://github.com/Trax-air/swagger-parser: A helper that parses swagger specs. You can access the HTTP actions / paths and some example data

Example Usage

import pytest
import requests

from swagger_stub import swagger_stub

# This is the fixture of your stub
# You only need to specify the path of the swagger file and the address
# where you want to bind your stub.
@pytest.fixture
def test_stub():
    return swagger_stub([('swagger.yaml', 'http://foo.com')]).next()

# Then you can use this fixture anywhere you want like your API is really running.
def test_swagger_stub(test_stub):
    # Get a definition example
    test_stub.definitions['Foo']

    # Check a simple call
    response = requests.get('http://foo.com/v1/bar/')
    assert response.status_code == 200
    assert response.json() == {
      'foo': 'bar'
    }

    # Check that an invalid body cause an error
    response = requests.post('http://foo.com/v1/bar/', data='invalid data')
    assert response.status_code == 400

    # Mock a call
    test_stub.add_mock_call('get', '/test', {'mock': 'call'})
    response = requests.get('http://foo.com/v1/test')
    assert response.json() == {'mock': 'call'}

    # Set some side_effect like in the mock library
    test_stub.add_mock_side_effect('get', '/iter', [{'test': '1'}, {'test': '2'}, {'test': '3'}])
    response = requests.get('http://foo.com/v1/iter')
    assert response.json() == {'test': '1'}
    response = requests.get('http://foo.com/v1/iter')
    assert response.json() == {'test': '2'}
    response = requests.get('http://foo.com/v1/iter')
    assert response.json() == {'test': '3'}

    # This side effect will raise a custom error
    test_stub.add_mock_side_effect('get', '/error', Exception)

    with pytest.raises(Exception):
        response = requests.get('http://foo.com/v1/error')

Documentation

More documentation is available at https://swagger-stub.readthedocs.org/en/latest/.

Setup

make install or pip install swagger-stub

License

swagger-stub is licensed under http://opensource.org/licenses/MIT.

0.2.1 (2016-6-6)

• Fix repeated base path.

0.2.0 (2016-5-2)

• Add access to definition example.

0.1.1 (2016-1-31)

• Change license to MIT.

0.1 (2016-1-29)

• First release on PyPI.