@hey-api/openapi-ts 0.61.3 → 0.62.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 +0 -29
- package/dist/index.cjs +4 -4
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +54 -63
- package/dist/index.d.ts +54 -63
- package/dist/index.js +4 -4
- package/dist/index.js.map +1 -1
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -178,35 +178,6 @@ Clients are responsible for sending the actual HTTP requests. The `client` value
|
|
|
178
178
|
|
|
179
179
|
You can learn more on the [Clients](https://heyapi.dev/openapi-ts/clients) page.
|
|
180
180
|
|
|
181
|
-
### Parser
|
|
182
|
-
|
|
183
|
-
If you're NOT using a legacy client, we encourage you to try out the experimental parser. Soon, it will become the default parser, but until it's been tested it's an opt-in feature. To try it out, set the `experimentalParser` flag in your configuration to `true`.
|
|
184
|
-
|
|
185
|
-
#### config
|
|
186
|
-
|
|
187
|
-
```js
|
|
188
|
-
export default {
|
|
189
|
-
client: '@hey-api/client-fetch',
|
|
190
|
-
experimentalParser: true,
|
|
191
|
-
input: 'path/to/openapi.json',
|
|
192
|
-
output: 'src/client',
|
|
193
|
-
};
|
|
194
|
-
```
|
|
195
|
-
|
|
196
|
-
#### cli
|
|
197
|
-
|
|
198
|
-
```sh
|
|
199
|
-
npx @hey-api/openapi-ts \
|
|
200
|
-
-c @hey-api/client-fetch \
|
|
201
|
-
-e \
|
|
202
|
-
-i path/to/openapi.json \
|
|
203
|
-
-o src/client
|
|
204
|
-
```
|
|
205
|
-
|
|
206
|
-
The experimental parser produces a cleaner output while being faster than the legacy parser. It also supports features such as [Filters](https://heyapi.dev/openapi-ts/configuration#filters) and more are being added.
|
|
207
|
-
|
|
208
|
-
The legacy parser will be used with the [legacy clients](https://heyapi.dev/openapi-ts/clients/legacy) regardless of the `experimentalParser` flag value. However, it's unlikely to receive any further updates.
|
|
209
|
-
|
|
210
181
|
## Plugins
|
|
211
182
|
|
|
212
183
|
Plugins are responsible for generating artifacts from your input. By default, Hey API will generate TypeScript interfaces and SDK from your OpenAPI specification. You can add, remove, or customize any of the plugins. In fact, we highly encourage you to do so!
|