A tool for validating an OpenAPI 3.0 specification against an implementation.

The main idea is to generate multiple requests (with parameters and request body being generated using hypothesis according to the schemas defined in the specification) for the operations, passing these to the suppliedsend_request function which is responsible for sending the request and returning the response, which in turn is validated against the specification using openapi_core. When an unexpected response occurs an exception is raised.

This tool is especially useful when you have an OpenAPI specification and an implementation of that spec and you want to check that the implementation actually conforms to the specification.

Use a package manager (e.g. poetry, pipenv or pip) e.g.

$ poetry add openapi_conformance

The main thing that is required in order to use is to supply a send_request function which translates a request object to an actual request to the implementation being tested. For example one might invoke an actualy http request using requests, or as in the following example use the django test client to send requests as part of your django tests.

from openapi_core.wrappers.mock import MockResponse
from django.test import Client, TestCase
from openapi_conformance import OpenAPIConformance


class OpenAPIConformanceTestCase(TestCase):

    def test_conformance(self):

        client = Client()
        client.login(username='john@doe.com', password='1234')
        
        def send_request(operation, request):
            path = request.path.format(**request.parameters["path"])
            response = getattr(client, request.method)(path)
            return MockResponse(response.content, response.status_code)
        
        openapi_conformance = OpenAPIConformance("petstore.yaml", send_request)
        openapi_conformance.check()

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

The steps for installing a development environment can be found in tools/bootstrap you can either run this script, or if you prefer perform the steps manually.

It is also advisable to run tools/hooks/install to add the pre-push hook to ensure remote changes are always linted and formatted correctly. Formatting can be fixed with the tools/format script.