@abitechdev/openchasqui-loader-openapi 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 +48 -7
- package/package.json +10 -3
package/README.md
CHANGED
|
@@ -1,12 +1,53 @@
|
|
|
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-loader-openapi
|
|
2
6
|
|
|
3
|
-
|
|
7
|
+
[](https://www.npmjs.com/package/@abitechdev/openchasqui-loader-openapi)
|
|
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
|
+
Lee documentos OpenAPI 3.0 y 3.1, en JSON o YAML, y los convierte al modelo de OpenChasqui: operaciones, parámetros, cuerpos, respuestas, seguridad y carpetas.
|
|
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
|
|
20
|
+
pnpm add @abitechdev/openchasqui-core @abitechdev/openchasqui-loader-openapi @abitechdev/openchasqui-emitter-bruno
|
|
21
|
+
yarn add @abitechdev/openchasqui-core @abitechdev/openchasqui-loader-openapi @abitechdev/openchasqui-emitter-bruno
|
|
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
|
+
|
|
34
|
+
const result = await run(
|
|
35
|
+
{ version: 1, source: "openapi.yaml", targets: ["bruno"], output: "collections" },
|
|
36
|
+
{
|
|
37
|
+
reader: { readText: (path) => readFile(path, "utf8") },
|
|
38
|
+
plugins: [openApiLoader, brunoEmitter],
|
|
39
|
+
},
|
|
40
|
+
);
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
La carpeta de cada operación sale de `x-openchasqui-folder`, de su primer
|
|
44
|
+
tag o del primer segmento de la ruta, en ese orden. `x-openchasqui-order` fija
|
|
45
|
+
su posición.
|
|
46
|
+
|
|
47
|
+
## Documentación
|
|
4
48
|
|
|
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).
|
|
49
|
+
[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
50
|
|
|
10
|
-
##
|
|
51
|
+
## Licencia
|
|
11
52
|
|
|
12
|
-
Apache-2.0
|
|
53
|
+
[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-loader-openapi",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "Loads OpenAPI 3.0 and 3.1 documents into the OpenChasqui model.",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"openapi",
|
|
7
|
+
"openapi3",
|
|
8
|
+
"swagger",
|
|
9
|
+
"loader",
|
|
10
|
+
"openchasqui"
|
|
11
|
+
],
|
|
5
12
|
"license": "Apache-2.0",
|
|
6
13
|
"type": "module",
|
|
7
14
|
"exports": {
|
|
@@ -24,9 +31,9 @@
|
|
|
24
31
|
"directory": "packages/loader-openapi"
|
|
25
32
|
},
|
|
26
33
|
"dependencies": {
|
|
27
|
-
"@abitechdev/openchasqui-spec": "^0.1.
|
|
34
|
+
"@abitechdev/openchasqui-spec": "^0.1.1"
|
|
28
35
|
},
|
|
29
36
|
"devDependencies": {
|
|
30
|
-
"@abitechdev/openchasqui-core": "^0.1.
|
|
37
|
+
"@abitechdev/openchasqui-core": "^0.1.1"
|
|
31
38
|
}
|
|
32
39
|
}
|