@sdk-it/cli 0.40.0 → 0.42.0
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 +8 -8
- package/package.json +7 -7
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# @sdk-it/cli
|
|
2
2
|
|
|
3
|
-
<p align="center">Command-line interface for SDK-IT that
|
|
3
|
+
<p align="center">Command-line interface for SDK-IT that generates type-safe client SDKs from OpenAPI specifications</p>
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
@@ -14,7 +14,7 @@ npx @sdk-it/cli
|
|
|
14
14
|
|
|
15
15
|
## Usage
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
Generate SDKs from OpenAPI specifications:
|
|
18
18
|
|
|
19
19
|
### Basic Command Structure
|
|
20
20
|
|
|
@@ -80,13 +80,13 @@ Let's generate a client SDK for the Hetzner Cloud API with automatic formatting:
|
|
|
80
80
|
npx sdk-it -s https://raw.githubusercontent.com/MaximilianKoestler/hcloud-openapi/refs/heads/main/openapi/hcloud.json -o ./client --formatter "prettier $SDK_IT_OUTPUT --write"
|
|
81
81
|
```
|
|
82
82
|
|
|
83
|
-
|
|
83
|
+
This command:
|
|
84
84
|
|
|
85
|
-
1.
|
|
86
|
-
2.
|
|
87
|
-
3. Prettier
|
|
85
|
+
1. Downloads the OpenAPI specification from the Hetzner Cloud documentation
|
|
86
|
+
2. Generates a type-safe TypeScript SDK in the `./client` directory
|
|
87
|
+
3. Runs Prettier on the generated code for consistent formatting
|
|
88
88
|
|
|
89
|
-
|
|
89
|
+
Use the generated SDK:
|
|
90
90
|
|
|
91
91
|
```typescript
|
|
92
92
|
import { Client } from './client';
|
|
@@ -100,7 +100,7 @@ const client = new Client({
|
|
|
100
100
|
});
|
|
101
101
|
|
|
102
102
|
// Call API methods with type safety
|
|
103
|
-
const servers = await client.request('GET /servers', {});
|
|
103
|
+
const [servers, error] = await client.request('GET /servers', {});
|
|
104
104
|
|
|
105
105
|
if (error) {
|
|
106
106
|
console.error('Error fetching servers:', error);
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@sdk-it/cli",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.42.0",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"main": "./dist/index.js",
|
|
6
6
|
"module": "./dist/index.js",
|
|
@@ -20,17 +20,17 @@
|
|
|
20
20
|
"!**/*.test.*"
|
|
21
21
|
],
|
|
22
22
|
"dependencies": {
|
|
23
|
-
"@sdk-it/typescript": "0.
|
|
24
|
-
"@sdk-it/dart": "0.
|
|
25
|
-
"@sdk-it/spec": "0.
|
|
23
|
+
"@sdk-it/typescript": "0.42.0",
|
|
24
|
+
"@sdk-it/dart": "0.42.0",
|
|
25
|
+
"@sdk-it/spec": "0.42.0",
|
|
26
26
|
"commander": "^13.1.0",
|
|
27
|
-
"@sdk-it/core": "0.
|
|
27
|
+
"@sdk-it/core": "0.42.0",
|
|
28
28
|
"libnpmpublish": "^11.0.0",
|
|
29
29
|
"openapi3-ts": "4.5.0",
|
|
30
30
|
"registry-auth-token": "^5.1.0",
|
|
31
|
-
"@sdk-it/python": "0.
|
|
31
|
+
"@sdk-it/python": "0.42.0",
|
|
32
32
|
"execa": "^9.6.0",
|
|
33
|
-
"@sdk-it/readme": "0.
|
|
33
|
+
"@sdk-it/readme": "0.42.0",
|
|
34
34
|
"@inquirer/prompts": "^7.7.1"
|
|
35
35
|
},
|
|
36
36
|
"publishConfig": {
|