Skip to content

Commit 5985219

Browse files
authored
docs: update readme with respect information (#2143)
* docs: update readme with respect information * docs: update readme with respect information * docs: update readme with respect information
1 parent 6fa7405 commit 5985219

File tree

2 files changed

+51
-7
lines changed

2 files changed

+51
-7
lines changed

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,37 @@ The `stylish` output is as good as it sounds, but if you need JSON, Markdown, Ch
101101

102102
[Learn more about API standards and configuring Redocly rules](https://redocly.com/docs/cli/api-standards).
103103

104+
### API contract testing with Respect
105+
106+
Ensure your APIs match their OpenAPI descriptions with **Respect**, Redocly's API contract testing system. Respect sends real HTTP requests to your API server and validates that responses match the expectations defined in your OpenAPI description and Arazzo workflows.
107+
108+
- Verify API responses match your OpenAPI schema
109+
- Test complex API sequences using OpenAPI Arazzo format
110+
- Catch API drift early in development and CI/CD
111+
- Ensure external APIs you depend on behave as expected
112+
- Track response times and detect anomalies
113+
114+
#### Quick start
115+
116+
```sh
117+
# Generate test workflows from your OpenAPI spec
118+
redocly generate-arazzo openapi.yaml
119+
120+
# Run contract tests against your API
121+
redocly respect auto-generated.arazzo.yaml --verbose
122+
```
123+
124+
#### Respect vs. Respect Monitoring
125+
126+
Respect is Redocly's community-edition product. Looking for something more? We also offer continuous API monitoring with additional features including:
127+
128+
- Real-time insights
129+
- Automated alerts via email or Slack
130+
- Automated API checks
131+
- Proactive API quality assurance
132+
133+
Learn more about [Respect](https://redocly.com/respect) and [get started with API contract testing](https://redocly.com/docs/respect/get-started).
134+
104135
### Transform an OpenAPI description
105136

106137
If your OpenAPI description isn't everything you hoped it would be, enhance it with the Redocly [decorators](https://redocly.com/docs/cli/decorators) feature.

packages/respect-core/README.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,25 @@ Continuous API monitoring powered by OpenAPI Arazzo workflows.
66

77
This package cannot be used standalone. Please install and use [@redocly/cli](https://github.com/Redocly/redocly-cli) to run API tests.
88

9-
The key benefits of `respect`:
9+
## What is Respect?
1010

11-
- Increases clarity and readability of tests.
12-
- Autogenerates tests from OpenAPI to get started quickly.
13-
- Maintain a positive reputation in your ecosystem (nobody likes when a 3rd party API change breaks their own software).
14-
- Efficient because it links API requests to corresponding OpenAPI descriptions automatically.
15-
- Shift left to catch problems fast before they are costly. Run on developer laptops and CICD.
11+
Respect is Redocly's API contract testing system that validates your APIs match their OpenAPI descriptions. It sends real HTTP requests to your API server and compares responses against the expectations defined in your OpenAPI specification and Arazzo workflows.
1612

17-
You **MUST** have a working API server running in order to run the tests because it sends real HTTP requests.
13+
- Write tests in human-readable Arazzo format
14+
- Get started quickly with auto-generated test workflows
15+
- Catch API drift before it breaks your ecosystem
16+
- Links API requests to OpenAPI descriptions automatically
17+
- Catch problems early in development and CI/CD pipelines
18+
19+
## Requirements
20+
21+
You **MUST** have a working API server running in order to run the tests because Respect sends real HTTP requests.
22+
23+
## Documentation and resources
24+
25+
- [Respect documentation](https://redocly.com/docs/respect)
26+
- [Getting started guide](https://redocly.com/docs/respect/get-started)
27+
- [Use cases](https://redocly.com/docs/respect/use-cases)
28+
- [Arazzo workflow testing](https://redocly.com/docs/respect/guides/test-api-sequences)
29+
- [Command reference](https://redocly.com/docs/respect/commands/respect)
30+
- [Respect CLI overview](https://redocly.com/respect-cli)

0 commit comments

Comments
 (0)