https://github.com/notaryio/notary
A contracts broker that provides a declarative way of sharing, validating & discovering contracts between multiple projects.
https://github.com/notaryio/notary
api api-documentation contract-management contract-testing contracts contracts-broker microservices rest-api swagger
Last synced: 5 months ago
JSON representation
A contracts broker that provides a declarative way of sharing, validating & discovering contracts between multiple projects.
- Host: GitHub
- URL: https://github.com/notaryio/notary
- Owner: notaryio
- License: mit
- Created: 2017-06-18T21:00:06.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-01-03T07:09:13.000Z (about 8 years ago)
- Last Synced: 2025-07-17T02:03:10.493Z (8 months ago)
- Topics: api, api-documentation, contract-management, contract-testing, contracts, contracts-broker, microservices, rest-api, swagger
- Language: JavaScript
- Homepage:
- Size: 1.04 MB
- Stars: 17
- Watchers: 3
- Forks: 1
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
A contracts broker that provides a declarative way of sharing, validating & discovering contracts between multiple projects.
Beside contracts validation, sharing & discovery, notary also allows you to generate all sort of extra artifacts out of those contracts like Client libraries, Stubbed endpoints, Dependency Graphs & much more.
Support for multiple popular integration patterns like REST APIs will be shipped out of the box, plus the ability to easily extend the project with "Integrations plugins" to support even more patterns.
## What is a *Contract*?
A contract is either a **Producer Promise** or a **Consumer Expectation**. In notary, it's a meta-data describing how to use a specific shared integration point, e.g.: a Swagger file describing exposed REST API endpoint including API versioning, paths, supported methods, response entities, etc..
## How does the provider/consumer validation work?
To validate your contracts you need to issue a request to the [validation endpoint]. Ideally, this will be done automatically in your CI pipeline.
The validation process includes:
1. Syntactic validation
1. Check if all of the project's promises satisfy its consumers
1. Check if all of the project's expectations are honored by its upstream providers
## What integration patterns does the project support so far?
1. [REST APIs](src/contracts/integrations/rest/README.md): Define contracts for RESTful API endpoints using the [Swagger spec](http://swagger.io/specification/)
1. [Frontend LocalStorage](src/contracts/integrations/localstorage/README.md): Define contracts for shared objects in the end-customer's browser LocalStorage using a specified [JSON schema](http://json-schema.org/)