specshield 3.2.8 → 3.2.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -6
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -17,8 +17,8 @@
|
|
|
17
17
|
**Commands — local & hosted compare**
|
|
18
18
|
- [Local Compare](#local-compare) · [Remote Compare](#remote-compare) · [Comparison History](#comparison-history) · [Share a Comparison](#share-a-comparison) · [GitHub App PR Checks](#github-app--pr-checks)
|
|
19
19
|
|
|
20
|
-
**
|
|
21
|
-
- [
|
|
20
|
+
**Contract Compatibility Testing — the `bdct` commands**
|
|
21
|
+
- [Overview & full command reference](#bi-directional-contract-testing-bdct)
|
|
22
22
|
- [`bdct capture from-har` — HAR → consumer contract](#bdct-capture-from-har--turn-real-traffic-into-a-consumer-contract)
|
|
23
23
|
- [Step 1 — record a HAR](#step-1--record-a-har-file) · [Step 2 — generate contract](#step-2--turn-the-har-into-a-consumer-contract) · [Step 3 — publish + gate](#step-3--publish--gate) · [Operational concerns](#operational-concerns-read-this-before-going-live)
|
|
24
24
|
- [`bdct verify-provider` — spec-vs-production conformance](#bdct-verify-provider--does-your-live-provider-actually-match-its-spec)
|
|
@@ -34,21 +34,23 @@
|
|
|
34
34
|
|
|
35
35
|
---
|
|
36
36
|
|
|
37
|
-
> **OpenAPI Diff · Breaking-Change Detection ·
|
|
37
|
+
> **Contract Compatibility Testing · OpenAPI Diff · Breaking-Change Detection · `can-i-deploy` Deploy Gate · Pact-File Ingest · Live-Traffic Capture · Spec-vs-Production Conformance · GitHub PR Checks**
|
|
38
38
|
|
|
39
39
|
---
|
|
40
40
|
|
|
41
41
|
## Never ship a breaking change to your API consumers
|
|
42
42
|
|
|
43
|
-
**SpecShield
|
|
43
|
+
**SpecShield is contract compatibility testing for APIs** — catch breaking changes before they reach your consumers, and gate every deploy with `can-i-deploy`. *(Contract compatibility testing is also known as bidirectional contract testing.)*
|
|
44
|
+
|
|
45
|
+
It's the one CLI that does four things to keep your API safe:
|
|
44
46
|
|
|
45
47
|
1. **Diff** two OpenAPI specs and fail CI on breaking changes.
|
|
46
|
-
2. **
|
|
48
|
+
2. **Contract compatibility testing** with `can-i-deploy` — block a deploy that would break a consumer.
|
|
47
49
|
3. **`bdct capture from-har`** — turn recorded traffic into an accurate consumer contract (no Pact DSL).
|
|
48
50
|
4. **`bdct verify-provider`** — prove the running provider actually matches its OpenAPI spec.
|
|
49
51
|
|
|
50
52
|
```
|
|
51
|
-
OpenAPI diff +
|
|
53
|
+
OpenAPI diff + contract compatibility checks + HAR → consumer contract + spec-vs-production conformance — in one CLI.
|
|
52
54
|
```
|
|
53
55
|
|
|
54
56
|
No broker. No Pact DSL. Language-agnostic. Works in 30 seconds. Local mode never uploads your specs.
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "specshield",
|
|
3
|
-
"version": "3.2.
|
|
4
|
-
"description": "
|
|
3
|
+
"version": "3.2.9",
|
|
4
|
+
"description": "Contract compatibility testing for APIs — catch breaking OpenAPI changes before they reach your consumers, with can-i-deploy deploy gating and GitHub PR checks. (a.k.a. bidirectional contract testing.)",
|
|
5
5
|
"main": "src/cli.js",
|
|
6
6
|
"bin": {
|
|
7
7
|
"specshield": "./bin/specshield.js"
|