💱 Compatibility

Great compatibility

Any standard 3.0.x implementation works very well.

We have tested Clientele with:

• FastAPI - our target audience, so 100% compatibility guaranteed.
• drf-spectacular works great as well, you can see which schemas we tested in this GitHub issue.
• Microsoft's OpenAPI spec has also been battle tested and works well.

No compatibility

We do not support 2.x aka "Swagger" - this format is quite different and deprecated.

A note on compatbility

When we were building Clientele, we discovered that, despite a fantastic specification, OpenAPI has a lot of poor implementations.

As pythonistas, we started with the auto-generated OpenAPI schemas provided by FastAPI, and then we branched out to large APIs like Twilio to test what we built.

Despite the effort, we still keep finding subtly different OpenAPI implementations.

Because of this we cannot guarentee 100% compatibility with an API, but we can give you a good indication of what we've tested.