Rivet

Docs | Issues

Rapid, modern web service development, which typically involves layers of microservices, reaches a point where a single, non-backwards-compatible API change affects multiple teams. This in turn leads to cascading service failures and finger-pointing. Rivet defines a solution where each service tests itself against real clients to assert that no interfaces have broken any clients at each step of the way.

• Introduction
• Consumer-Driven Contracts
• Getting Started
• Contracts
  • Configuration
  • Helpers
  • Composability
  • Publishing
• CLI

Getting Started

Install Rivet using npm:

npm install --save-dev rivet

Or via yarn:

yarn add --dev rivet

Read more in the Getting Started docs.

Vocabulary

Rivet uses services and consumers in describing these relationships.

• Consumer — A client that talks to an API service
• Service — An API service that consumers depend on for data

The Problem

With these types of service relationships, trouble arises when you'd like to make a change to an API without breaking other consumers.

People use tools like API Blueprint, Swagger, or tests within the API's code itself to specify the requirements for an API. However, these tools and strategies do not account for the consuming applications that may break. You can change a response within the API's codebase and not know whether you've broken any given consumer.

The Solution

By having the consumers define their requirements through contracts, you gain direct visibility into any consumer-breaking change to a service. For example, if you are forced to make a backwards-incompatible change (due to security, something upstream, or something simply out of your control), making the service aware of each client's requirements will tell you exactly what clients need to be updated to handle the change, whether or not you have versioned API mechanisms.

Generic Metaphor

For example, take a factory that manufactures widgets:

Two customers come to have widgets made. The factory has a base widget (with twist it, bop it, spin it) that it modifies for different customers' needs, defined in a contract.

• Customer 1: widget with twist it, bop it, spin it

• Customer 2: widget with twist it, spin it

• Factory: Removes bop it, without checking the contracts in place for their customer orders

• Customer 1: Now mad that they don't have a bop it anymore

• Customer 2: Doesn't notice the change because it's not required

If the factory had checked the contracts that were in place, they would have known to add a bop it for Customer 1. In this scenario, the Factory is a service, and Customers are consumers. It's absurd to imagine a Factory not checking manufacturing contracts before delivering their widgets. In the same way, it's absurd to imagine that in software, a service doesn't check requirements before delivering a change.