@abitechdev/openchasqui-generator-tests 0.1.0 → 0.1.2
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 +54 -7
- package/package.json +13 -6
package/README.md
CHANGED
|
@@ -1,12 +1,59 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<a href="https://github.com/abitech-dev/abitech-openchasqui-cli#readme"><img alt="OpenChasqui" src="https://raw.githubusercontent.com/abitech-dev/abitech-openchasqui-cli/main/.github/assets/logo-light.svg" width="320"></a>
|
|
3
|
+
</p>
|
|
4
|
+
|
|
1
5
|
# @abitechdev/openchasqui-generator-tests
|
|
2
6
|
|
|
3
|
-
|
|
7
|
+
[](https://www.npmjs.com/package/@abitechdev/openchasqui-generator-tests)
|
|
8
|
+
[](https://github.com/abitech-dev/abitech-openchasqui-cli/actions/workflows/ci.yml)
|
|
9
|
+
[](https://github.com/abitech-dev/abitech-openchasqui-cli/blob/main/LICENSE)
|
|
10
|
+
|
|
11
|
+
Genera pruebas de contrato para cada petición: código de estado, tipo de contenido, esquema de la respuesta y tiempo de respuesta.
|
|
12
|
+
|
|
13
|
+
> **¿Solo quieres generar colecciones?** Instala el CLI,
|
|
14
|
+
> [`@abitechdev/openchasqui`](https://www.npmjs.com/package/@abitechdev/openchasqui), que ya incluye este paquete.
|
|
15
|
+
|
|
16
|
+
## Instalación
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
npm i @abitechdev/openchasqui-core @abitechdev/openchasqui-loader-openapi @abitechdev/openchasqui-emitter-bruno @abitechdev/openchasqui-generator-tests
|
|
20
|
+
pnpm add @abitechdev/openchasqui-core @abitechdev/openchasqui-loader-openapi @abitechdev/openchasqui-emitter-bruno @abitechdev/openchasqui-generator-tests
|
|
21
|
+
yarn add @abitechdev/openchasqui-core @abitechdev/openchasqui-loader-openapi @abitechdev/openchasqui-emitter-bruno @abitechdev/openchasqui-generator-tests
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
Requiere Node.js 22 o superior.
|
|
25
|
+
|
|
26
|
+
## Uso
|
|
27
|
+
|
|
28
|
+
```ts
|
|
29
|
+
import { readFile } from "node:fs/promises";
|
|
30
|
+
import { run } from "@abitechdev/openchasqui-core";
|
|
31
|
+
import { openApiLoader } from "@abitechdev/openchasqui-loader-openapi";
|
|
32
|
+
import { brunoEmitter } from "@abitechdev/openchasqui-emitter-bruno";
|
|
33
|
+
import { testsGenerator } from "@abitechdev/openchasqui-generator-tests";
|
|
34
|
+
|
|
35
|
+
const result = await run(
|
|
36
|
+
{ version: 1, source: "openapi.yaml", targets: ["bruno"], output: "collections" },
|
|
37
|
+
{
|
|
38
|
+
reader: { readText: (path) => readFile(path, "utf8") },
|
|
39
|
+
plugins: [openApiLoader, testsGenerator, brunoEmitter],
|
|
40
|
+
},
|
|
41
|
+
);
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
`forValidators` convierte un esquema OpenAPI en JSON Schema que Ajv acepta:
|
|
45
|
+
|
|
46
|
+
```ts
|
|
47
|
+
import { forValidators } from "@abitechdev/openchasqui-generator-tests";
|
|
48
|
+
|
|
49
|
+
forValidators({ type: "string", format: "date", nullable: true });
|
|
50
|
+
// { type: ["string", "null"] }
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
## Documentación
|
|
4
54
|
|
|
5
|
-
|
|
6
|
-
([en español](https://github.com/abitech-dev/abitech-openchasqui-cli#readme)), which generates API collections from
|
|
7
|
-
OpenAPI. Most projects only need the command line,
|
|
8
|
-
[`@abitechdev/openchasqui`](https://www.npmjs.com/package/@abitechdev/openchasqui).
|
|
55
|
+
[Español](https://github.com/abitech-dev/abitech-openchasqui-cli#readme) · [English](https://github.com/abitech-dev/abitech-openchasqui-cli/blob/main/README.en.md)
|
|
9
56
|
|
|
10
|
-
##
|
|
57
|
+
## Licencia
|
|
11
58
|
|
|
12
|
-
Apache-2.0
|
|
59
|
+
[Apache-2.0](https://github.com/abitech-dev/abitech-openchasqui-cli/blob/main/LICENSE). Parte de [OpenChasqui](https://github.com/abitech-dev/abitech-openchasqui-cli).
|
package/package.json
CHANGED
|
@@ -1,7 +1,14 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@abitechdev/openchasqui-generator-tests",
|
|
3
|
-
"version": "0.1.
|
|
4
|
-
"description": "
|
|
3
|
+
"version": "0.1.2",
|
|
4
|
+
"description": "Genera pruebas de estado, tipo de contenido, esquema y tiempo de respuesta desde el contrato.",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"openapi",
|
|
7
|
+
"contract-testing",
|
|
8
|
+
"api-testing",
|
|
9
|
+
"json-schema",
|
|
10
|
+
"openchasqui"
|
|
11
|
+
],
|
|
5
12
|
"license": "Apache-2.0",
|
|
6
13
|
"type": "module",
|
|
7
14
|
"exports": {
|
|
@@ -24,11 +31,11 @@
|
|
|
24
31
|
"directory": "packages/generator-tests"
|
|
25
32
|
},
|
|
26
33
|
"dependencies": {
|
|
27
|
-
"@abitechdev/openchasqui-plugin-kit": "^0.1.
|
|
28
|
-
"@abitechdev/openchasqui-spec": "^0.1.
|
|
34
|
+
"@abitechdev/openchasqui-plugin-kit": "^0.1.2",
|
|
35
|
+
"@abitechdev/openchasqui-spec": "^0.1.2"
|
|
29
36
|
},
|
|
30
37
|
"devDependencies": {
|
|
31
|
-
"@abitechdev/openchasqui-core": "^0.1.
|
|
32
|
-
"@abitechdev/openchasqui-loader-openapi": "^0.1.
|
|
38
|
+
"@abitechdev/openchasqui-core": "^0.1.2",
|
|
39
|
+
"@abitechdev/openchasqui-loader-openapi": "^0.1.2"
|
|
33
40
|
}
|
|
34
41
|
}
|