@redocly/respect-core 0.0.0-snapshot.1750342295 → 0.0.0-snapshot.1750940951
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
CHANGED
|
@@ -6,12 +6,25 @@ Continuous API monitoring powered by OpenAPI Arazzo workflows.
|
|
|
6
6
|
|
|
7
7
|
This package cannot be used standalone. Please install and use [@redocly/cli](https://github.com/Redocly/redocly-cli) to run API tests.
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
## What is Respect?
|
|
10
10
|
|
|
11
|
-
|
|
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.
|
|
16
12
|
|
|
17
|
-
|
|
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)
|
|
@@ -4,7 +4,7 @@ import { loadConfig, bundle, bundleFromString } from '@redocly/openapi-core';
|
|
|
4
4
|
import { isURL } from '../../utils/is-url.js';
|
|
5
5
|
export async function bundleOpenApi(path = '', workflowPath) {
|
|
6
6
|
const isUrl = isURL(path);
|
|
7
|
-
const config = await loadConfig();
|
|
7
|
+
const config = await loadConfig(); // FIXME: accept config from the run handler
|
|
8
8
|
let bundleDocument;
|
|
9
9
|
if (isUrl) {
|
|
10
10
|
// Download OpenAPI YAML file
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"bundle-openapi.js","sourceRoot":"","sources":["../../../src/modules/description-parser/bundle-openapi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAE7E,OAAO,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAE9C,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,OAAe,EAAE,EAAE,YAAoB;IACzE,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;IAC1B,MAAM,MAAM,GAAG,MAAM,UAAU,EAAE,CAAC;
|
|
1
|
+
{"version":3,"file":"bundle-openapi.js","sourceRoot":"","sources":["../../../src/modules/description-parser/bundle-openapi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAE7E,OAAO,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAE9C,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,OAAe,EAAE,EAAE,YAAoB;IACzE,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;IAC1B,MAAM,MAAM,GAAG,MAAM,UAAU,EAAE,CAAC,CAAC,4CAA4C;IAC/E,IAAI,cAA4B,CAAC;IAEjC,IAAI,KAAK,EAAE,CAAC;QACV,6BAA6B;QAC7B,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,CAAC;QAEnC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,8CAA8C,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;QACnF,CAAC;QAED,MAAM,WAAW,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QAC1C,cAAc,GAAG,MAAM,gBAAgB,CAAC;YACtC,MAAM,EAAE,WAAW;YACnB,MAAM;YACN,WAAW,EAAE,IAAI;SAClB,CAAC,CAAC;IACL,CAAC;SAAM,CAAC;QACN,MAAM,eAAe,GAAG,IAAI,IAAI,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,IAAI,CAAC,CAAC;QAErE,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,EAAE,CAAC;YACjC,MAAM,IAAI,KAAK,CAAC,2CAA2C,IAAI,cAAc,YAAY,GAAG,CAAC,CAAC;QAChG,CAAC;QAED,cAAc,GAAG,MAAM,MAAM,CAAC;YAC5B,GAAG,EAAE,eAAe;YACpB,MAAM;YACN,WAAW,EAAE,IAAI;SAClB,CAAC,CAAC;IACL,CAAC;IAED,IAAI,CAAC,cAAc;QAAE,OAAO;IAE5B,MAAM,EACJ,MAAM,EAAE,EACN,MAAM,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,GACvD,GACF,GAAG,cAAc,CAAC;IAEnB,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC;AACxD,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@redocly/respect-core",
|
|
3
|
-
"version": "0.0.0-snapshot.
|
|
3
|
+
"version": "0.0.0-snapshot.1750940951",
|
|
4
4
|
"description": "API testing framework core",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"types": "lib/index.d.ts",
|
|
@@ -43,7 +43,7 @@
|
|
|
43
43
|
"dependencies": {
|
|
44
44
|
"@faker-js/faker": "^7.6.0",
|
|
45
45
|
"@redocly/ajv": "8.11.2",
|
|
46
|
-
"@redocly/openapi-core": "0.0.0-snapshot.
|
|
46
|
+
"@redocly/openapi-core": "0.0.0-snapshot.1750940951",
|
|
47
47
|
"better-ajv-errors": "^1.2.0",
|
|
48
48
|
"colorette": "^2.0.20",
|
|
49
49
|
"concat-stream": "^2.0.0",
|