@abitechdev/openchasqui-emitter-postman 0.1.0 → 0.1.1
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 +46 -7
- package/package.json +12 -5
package/README.md
CHANGED
|
@@ -1,12 +1,51 @@
|
|
|
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-emitter-postman
|
|
2
6
|
|
|
3
|
-
|
|
7
|
+
[](https://www.npmjs.com/package/@abitechdev/openchasqui-emitter-postman)
|
|
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 la colección de Postman (Collection v2.1) con carpetas, un entorno por cada uno de la configuración y pruebas en cada petición. Los secretos van como variables sin valor.
|
|
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-postman
|
|
20
|
+
pnpm add @abitechdev/openchasqui-core @abitechdev/openchasqui-loader-openapi @abitechdev/openchasqui-emitter-postman
|
|
21
|
+
yarn add @abitechdev/openchasqui-core @abitechdev/openchasqui-loader-openapi @abitechdev/openchasqui-emitter-postman
|
|
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 { postmanEmitter } from "@abitechdev/openchasqui-emitter-postman";
|
|
33
|
+
|
|
34
|
+
const result = await run(
|
|
35
|
+
{ version: 1, source: "openapi.yaml", targets: ["postman"], output: "collections" },
|
|
36
|
+
{
|
|
37
|
+
reader: { readText: (path) => readFile(path, "utf8") },
|
|
38
|
+
plugins: [openApiLoader, postmanEmitter],
|
|
39
|
+
},
|
|
40
|
+
);
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
La colección se importa en Postman o se corre con `newman run`.
|
|
44
|
+
|
|
45
|
+
## Documentación
|
|
4
46
|
|
|
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).
|
|
47
|
+
[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
48
|
|
|
10
|
-
##
|
|
49
|
+
## Licencia
|
|
11
50
|
|
|
12
|
-
Apache-2.0
|
|
51
|
+
[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-emitter-postman",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "Emits Postman Collection v2.1 with environments and tests.",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"openapi",
|
|
7
|
+
"postman",
|
|
8
|
+
"postman-collection",
|
|
9
|
+
"newman",
|
|
10
|
+
"openchasqui"
|
|
11
|
+
],
|
|
5
12
|
"license": "Apache-2.0",
|
|
6
13
|
"type": "module",
|
|
7
14
|
"exports": {
|
|
@@ -24,11 +31,11 @@
|
|
|
24
31
|
"directory": "packages/emitter-postman"
|
|
25
32
|
},
|
|
26
33
|
"dependencies": {
|
|
27
|
-
"@abitechdev/openchasqui-spec": "^0.1.
|
|
28
|
-
"@abitechdev/openchasqui-plugin-kit": "^0.1.
|
|
34
|
+
"@abitechdev/openchasqui-spec": "^0.1.1",
|
|
35
|
+
"@abitechdev/openchasqui-plugin-kit": "^0.1.1"
|
|
29
36
|
},
|
|
30
37
|
"devDependencies": {
|
|
31
|
-
"@abitechdev/openchasqui-
|
|
32
|
-
"@abitechdev/openchasqui-
|
|
38
|
+
"@abitechdev/openchasqui-core": "^0.1.1",
|
|
39
|
+
"@abitechdev/openchasqui-loader-openapi": "^0.1.1"
|
|
33
40
|
}
|
|
34
41
|
}
|