ContractGuard
ContractGuard is a developer tool for FastAPI applications that helps you detect and manage API contract changes.
It generates your application's OpenAPI schema, stores a baseline contract, and compares future changes against that baseline so you can identify breaking API changes before they reach production.
Why ContractGuard?
APIs evolve constantly.
You add a new endpoint, rename a response field, change a parameter, modify a request body, or remove an endpoint.
The problem is that some of these changes can silently break existing clients.
ContractGuard helps you answer:
"Did my API contract change?"
and more importantly:
"Did I accidentally introduce a breaking change?"
Features
- Generate OpenAPI schema from a FastAPI application
- Initialize an API contract baseline
- Compare the current API schema with the stored contract
- Detect API contract changes
- Check contracts from the command line
- Update the stored contract after intentional changes
- Generate API documentation
- Designed specifically for FastAPI projects
- Simple CLI workflow
-- TO BE LAUNCHED SOON
Release files for fastapi-contractguard 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| fastapi_contractguard-0.1.0.tar.gz | 6.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| fastapi_contractguard-0.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 13.4 kB
Release files / fastapi_contractguard-0.1.0.tar.gz
| Download URL | fastapi_contractguard-0.1.0.tar.gz |
|---|---|
| Size | 6.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8d2f4dc2205f85b32835943a6ffcb133f551db37e0acff3de4683f28ca8cc581
|
|
BLAKE2b-256 checksum How to use checksums |
5827a1bfa61ffdb3f75699750eee47496184aba41f688c3a4822bb02293a028d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
Release files / fastapi_contractguard-0.1.0-py3-none-any.whl
| Download URL | fastapi_contractguard-0.1.0-py3-none-any.whl |
|---|---|
| Size | 7.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
814c931942ac2aba4c1fe3486dc0f1baf30278c0b44d863767291a8d1ac01ba4
|
|
BLAKE2b-256 checksum How to use checksums |
e19cc5b953b63b041f4141adc7f709d6ae5a94cb5298357589bfc48b5a381c08
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|