@@ -9,22 +9,53 @@ npm i -g @nkmr-jp/api-to-go
9
9
```
10
10
11
11
# Usage
12
- add config file ` .api-to-go.yml ` .
13
- ``` yaml
12
+ ``` sh
13
+ $ api-to-go --help
14
+ Usage: api-to-go [options] < url> [body]
15
+
16
+ Convert REST API' s JSON payload to Golang struct.
17
+
18
+ Arguments:
19
+ url URL (required)
20
+ body HTTP request body. specify by json string or file(json|yml).
21
+
22
+ Options:
23
+ -v, --version output the current version
24
+ -H, --headers <string> http request headers. specify by json string or file(json|yml).
25
+ -X, --method <string> specify request method to use.
26
+ --config <string> location of client config files. (default: "./.api-to-go.yml")
27
+ -D, --debug enable debug mode
28
+ -h, --help display help for command
29
+ ```
30
+
31
+
32
+ # Quick Start
33
+
34
+ Add config file `.api-to-go.yml`.
35
+ ```yml
14
36
api.github.com:
37
+ docs:
38
+ - https://docs.github.com/en/rest
15
39
format:
16
40
- /users/{user}
17
41
- /users/{user}/repos
18
42
```
19
- run command.
43
+
44
+ Run command.
20
45
```sh
21
46
cd [your project dir]
22
47
api-to-go https://api.github.com/users/github/repos
23
- # > format: /users/{user}/repos
24
- # > generated: api.github.com/users/user/repos.go
25
- # > saved: api.github.com/users/user/repos_sample.json
48
+ # > Status: 200 OK
49
+ # > Request: GET https://api.github.com/users/github/repos
50
+ # > Format: /users/{user}/repos
51
+ # > Docs: https://docs.github.com/en/rest
52
+
53
+ # > Response Body:
54
+ # > - api.github.com/users/user/repos.go:1
55
+ # > - api.github.com/users/user/repos.json:1
26
56
```
27
- check generated files and directories.
57
+
58
+ Generated files and directories.
28
59
```sh
29
60
tree -a .
30
61
# > .
@@ -33,9 +64,10 @@ check generated files and directories.
33
64
# > └── users
34
65
# > └── user
35
66
# > ├── repos.go
36
- # > └── repos_sample .json
67
+ # > └── repos .json
37
68
```
38
- check generated struct file ` ./api.github.com/users/user/repos.go ` .
69
+
70
+ Generated struct file `./api.github.com/users/user/repos.go`.
39
71
```go
40
72
package user
41
73
0 commit comments