@powerlines/plugin-hey-api 0.1.632 → 0.1.633
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 +31 -0
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -74,6 +74,37 @@ A Powerlines plugin to generate project code with [OpenAPI](https://heyapi.dev/)
|
|
|
74
74
|
|
|
75
75
|
<!-- END doctoc -->
|
|
76
76
|
|
|
77
|
+
## Features
|
|
78
|
+
|
|
79
|
+
- Generates typed API clients from OpenAPI schemas with Hey API
|
|
80
|
+
- Resolves schemas from URL or inline documents; fills missing `operationId` values from operation summaries
|
|
81
|
+
- Delegates generation to the Power Plant plugin; `createOperationId` helper under `./helpers/create-operation-id`
|
|
82
|
+
|
|
83
|
+
## Usage
|
|
84
|
+
|
|
85
|
+
Install the plugin:
|
|
86
|
+
|
|
87
|
+
```bash
|
|
88
|
+
pnpm add @powerlines/plugin-hey-api
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
Register it in `powerlines.config.ts`:
|
|
92
|
+
|
|
93
|
+
```ts
|
|
94
|
+
import { defineConfig } from "powerlines";
|
|
95
|
+
import { plugin as heyApi } from "@powerlines/plugin-hey-api";
|
|
96
|
+
|
|
97
|
+
export default defineConfig({
|
|
98
|
+
plugins: [
|
|
99
|
+
heyApi({
|
|
100
|
+
schema: "https://api.example.com/openapi.json"
|
|
101
|
+
})
|
|
102
|
+
]
|
|
103
|
+
});
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
Run the Powerlines build for your project to activate the plugin.
|
|
107
|
+
|
|
77
108
|
## Installing
|
|
78
109
|
|
|
79
110
|
Using [pnpm](http://pnpm.io):
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@powerlines/plugin-hey-api",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.633",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "A Powerlines plugin to generate project code using Hey API.",
|
|
6
6
|
"repository": {
|
|
@@ -120,20 +120,20 @@
|
|
|
120
120
|
"@hey-api/openapi-ts": "^0.88.2",
|
|
121
121
|
"@power-plant/core": "^0.0.98",
|
|
122
122
|
"@power-plant/hey-api": "^0.0.94",
|
|
123
|
-
"@powerlines/plugin-power-plant": "^0.1.
|
|
123
|
+
"@powerlines/plugin-power-plant": "^0.1.74",
|
|
124
124
|
"@stryke/path": "^0.29.43",
|
|
125
125
|
"@stryke/string-format": "^0.17.58",
|
|
126
126
|
"@stryke/type-checks": "^0.6.49",
|
|
127
127
|
"@stryke/types": "^0.12.44",
|
|
128
128
|
"defu": "^6.1.7",
|
|
129
129
|
"jiti": "^2.7.0",
|
|
130
|
-
"powerlines": "^0.47.
|
|
130
|
+
"powerlines": "^0.47.217"
|
|
131
131
|
},
|
|
132
132
|
"devDependencies": {
|
|
133
|
-
"@powerlines/plugin-plugin": "^0.12.
|
|
133
|
+
"@powerlines/plugin-plugin": "^0.12.630",
|
|
134
134
|
"@types/node": "^25.9.9"
|
|
135
135
|
},
|
|
136
136
|
"publishConfig": { "access": "public" },
|
|
137
137
|
"types": "./dist/index.d.cts",
|
|
138
|
-
"gitHead": "
|
|
138
|
+
"gitHead": "bb4e1f2b32a8bb9d20559ca7c3df3a2f30a0d14e"
|
|
139
139
|
}
|