@get-enlace/nest 0.0.8 → 0.0.9
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/LICENSE +1 -1
- package/README.md +8 -14
- package/package.json +3 -3
package/LICENSE
CHANGED
package/README.md
CHANGED
|
@@ -1,9 +1,12 @@
|
|
|
1
1
|
# @get-enlace/nest
|
|
2
2
|
|
|
3
|
-
NestJS adapter for [Enlace](https://github.com/get-enlace/enlace
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
(
|
|
3
|
+
NestJS adapter for [Enlace](https://github.com/get-enlace/enlace) — an interactive visual execution graph for any OpenAPI 3.x API.
|
|
4
|
+
|
|
5
|
+
[](https://www.npmjs.com/package/@get-enlace/nest)
|
|
6
|
+
[](https://enlace-fastapi.onrender.com/enlace/)
|
|
7
|
+
[](https://github.com/get-enlace/enlace)
|
|
8
|
+
|
|
9
|
+
This adapter's job is intentionally small: it serves the OpenAPI document and the `@get-enlace/ui` static bundle. Everything else (wiring up a chain, concurrent execution, credentials) happens client-side in the browser. Full documentation: [get-enlace.github.io](https://get-enlace.github.io/).
|
|
7
10
|
|
|
8
11
|
## Install
|
|
9
12
|
|
|
@@ -37,15 +40,6 @@ export class AppModule {}
|
|
|
37
40
|
|
|
38
41
|
`spec` accepts a file path, a URL, or an already-parsed OpenAPI 3.x object.
|
|
39
42
|
|
|
40
|
-
### What Enlace needs from your spec
|
|
41
|
-
|
|
42
|
-
Whatever produces it, `servers[0].url` needs to be your API's real, reachable base URL — Enlace
|
|
43
|
-
sends every request in a chain straight there from the browser. `operationId` is optional (Enlace
|
|
44
|
-
falls back to a synthetic `METHOD /path` label without one) but is what shows on the node and in
|
|
45
|
-
the operation search — `@nestjs/swagger` sets one per route by default (`ControllerName_methodName`).
|
|
46
|
-
|
|
47
|
-
Already serving `@nestjs/swagger`'s own Swagger UI from that same document? Handing it to Enlace
|
|
48
|
-
too doesn't change how that keeps working — they're independent consumers of the same object.
|
|
49
43
|
|
|
50
44
|
### Custom mount path
|
|
51
45
|
|
|
@@ -59,5 +53,5 @@ export class AppModule {}
|
|
|
59
53
|
## Learn more
|
|
60
54
|
|
|
61
55
|
See the [`enlace-js` repo](https://github.com/get-enlace/enlace-js) for the other adapters in
|
|
62
|
-
this family, and the [`enlace
|
|
56
|
+
this family, and the [`enlace` repo](https://github.com/get-enlace/enlace) for how Enlace
|
|
63
57
|
itself works.
|
package/package.json
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@get-enlace/nest",
|
|
3
3
|
"private": false,
|
|
4
|
-
"version": "0.0.
|
|
5
|
-
"description": "
|
|
4
|
+
"version": "0.0.9",
|
|
5
|
+
"description": "NestJS adapter for Enlace — an interactive visual execution graph for OpenAPI 3.x APIs.",
|
|
6
6
|
"license": "MIT",
|
|
7
7
|
"repository": {
|
|
8
8
|
"type": "git",
|
|
@@ -36,7 +36,7 @@
|
|
|
36
36
|
"reflect-metadata": "^0.1.13 || ^0.2.0"
|
|
37
37
|
},
|
|
38
38
|
"dependencies": {
|
|
39
|
-
"@get-enlace/ui": "0.0.
|
|
39
|
+
"@get-enlace/ui": "0.0.9",
|
|
40
40
|
"js-yaml": "^4.1.0"
|
|
41
41
|
},
|
|
42
42
|
"devDependencies": {
|