/
main.go
331 lines (280 loc) · 7.9 KB
/
main.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
package main
import (
"encoding/json"
"errors"
"flag"
"fmt"
"io/ioutil"
"os"
"sort"
"strings"
)
type OpenAPI struct {
Info struct {
Title string `json:"title"`
Description string `json:"description"`
Version string `json:"version"`
} `json:"info"`
Paths map[string]map[string]Method `json:"paths"`
Components struct {
Schemas map[string]Schema `json:"schemas"`
} `json:"components"`
}
type Method struct {
OperationID string `json:"operationId"`
Summary string `json:"summary"`
Description *string `json:"description"`
Parameters []struct {
Name string `json:"name"`
Required bool `json:"required"`
In string `json:"in"`
Schema struct {
Type string `json:"type"`
} `json:"schema"`
} `json:"parameters"`
RequestBody struct {
Required bool `json:"required"`
Content struct {
ApplicationJSON struct {
Schema struct {
Ref string `json:"$ref"`
Type string `json:"type"`
Items struct {
Ref string `json:"$ref"`
} `json:"items"`
} `json:"schema"`
} `json:"application/json"`
} `json:"content"`
} `json:"requestBody"`
Responses map[string]struct {
Description string `json:"description"`
Content struct {
ApplicationJSON struct {
Schema struct {
Ref string `json:"$ref"`
Type string `json:"type"`
Items struct {
Ref string `json:"$ref"`
} `json:"items"`
} `json:"schema"`
} `json:"application/json"`
} `json:"content"`
} `json:"responses"`
Tags []string `json:"tags"`
}
type Schema struct {
Type string `json:"type"`
Properties map[string]struct {
Format string `json:"format"`
Type string `json:"type"`
Example *string `json:"example"`
Nullable bool `json:"nullable"`
} `json:"properties"`
Required []string `json:"required"`
}
func main() {
if len(os.Args) < 3 {
fmt.Println("Usage: apibconv -f input.json -o output.apib")
return
}
inputFlag := flag.String("f", "", "Path to the input OpenAPI JSON file")
outputFlag := flag.String("o", "", "Path to the output API Blueprint file")
flag.Parse()
if *inputFlag == "" {
fmt.Println("Error: Input file is required")
os.Exit(1)
}
if *outputFlag == "" {
fmt.Println("Error: Output file is required")
os.Exit(1)
}
inputData, err := ioutil.ReadFile(*inputFlag)
if err != nil {
fmt.Printf("Error: Cannot read input file '%s': %v\n", *inputFlag, err)
os.Exit(1)
}
api, err := parseOpenAPI(inputData)
if err != nil {
fmt.Printf("Error: Cannot parse input file '%s': %v\n", *inputFlag, err)
os.Exit(1)
}
apiBlueprint, err := createAPIBlueprint(api)
if err != nil {
fmt.Printf("Error: Cannot convert to API Blueprint: %v\n", err)
os.Exit(1)
}
err = ioutil.WriteFile(*outputFlag, []byte(apiBlueprint), 0o644)
if err != nil {
fmt.Printf("Error: Cannot write output file '%s': %v\n", *outputFlag, err)
os.Exit(1)
}
}
func parseOpenAPI(data []byte) (OpenAPI, error) {
var api OpenAPI
err := json.Unmarshal(data, &api)
if err != nil {
return OpenAPI{}, errors.New("unable to parse OpenAPI JSON")
}
return api, nil
}
func formatAttributes(schema Schema) string {
var sb strings.Builder
sb.WriteString("+ Attributes \n")
for propName, prop := range schema.Properties {
var example string
if prop.Example != nil {
example = ": " + *prop.Example
}
if prop.Nullable {
sb.WriteString(" + " + propName + example + " (" + prop.Type + ", optional, nullable)\n")
} else {
sb.WriteString(" + " + propName + example + " (" + prop.Type + ", optional)\n")
}
}
return sb.String()
}
func formatBody(schemaType string, schema Schema) string {
if schemaType == "object" {
example := make(map[string]interface{})
for propName, prop := range schema.Properties {
propValue := propValue(prop.Type)
if prop.Example != nil {
propValue = *prop.Example
}
if prop.Nullable {
example[propName] = nil
} else {
example[propName] = propValue
}
}
jsonBytes, _ := json.MarshalIndent(example, " ", " ")
return string(jsonBytes)
} else if schemaType == "array" {
example := make([]interface{}, 1)
for propName, prop := range schema.Properties {
propValue := propValue(prop.Type)
if prop.Example != nil {
propValue = *prop.Example
}
if prop.Nullable {
example[0] = map[string]interface{}{propName: nil}
} else {
example[0] = map[string]interface{}{propName: propValue}
}
}
jsonBytes, _ := json.MarshalIndent(example, " ", " ")
return string(jsonBytes)
}
return ""
}
func isRequired(required bool) string {
if required {
return "required"
}
return "optional"
}
func propValue(valueType string) interface{} {
switch valueType {
case "string":
return "string"
case "number":
return 0
case "boolean":
return true
case "object":
return map[string]interface{}{}
default:
return nil
}
}
func formatOperation(method, path string, operation Method, componentSchemas map[string]Schema) string {
var sb strings.Builder
sb.WriteString("## " + operation.Summary + " [" + strings.ToUpper(method) + " " + path + "]\n")
if operation.Description != nil {
sb.WriteString(*operation.Description + "\n")
}
sb.WriteString("\n")
var hasQuery bool
for _, param := range operation.Parameters {
if param.In == "query" {
hasQuery = true
}
}
if hasQuery {
sb.WriteString("+ Parameters\n")
}
for _, param := range operation.Parameters {
if param.In == "query" {
sb.WriteString(" + " + param.Name + " (" + param.Schema.Type + ", " + isRequired(param.Required) + ") \n")
}
}
if hasQuery {
sb.WriteString("\n")
}
if strings.ToUpper(method) == "PATCH" || strings.ToUpper(method) == "POST" {
var refPath, schemaType string
requestBodySchema := operation.RequestBody.Content.ApplicationJSON.Schema
if requestBodySchema.Ref != "" {
schemaType = "object"
refPath = requestBodySchema.Ref
}
if requestBodySchema.Items.Ref != "" {
schemaType = "array"
refPath = requestBodySchema.Items.Ref
}
ref := strings.TrimPrefix(refPath, "#/components/schemas/")
attributesSchema := componentSchemas[ref]
sb.WriteString(formatAttributes(attributesSchema))
sb.WriteString("\n")
sb.WriteString("+ Request (application/json)\n\n")
sb.WriteString(" + Headers\n\n")
sb.WriteString(" Authorization: Bearer <JWT>\n\n")
sb.WriteString(" + Body\n\n")
sb.WriteString(" " + formatBody(schemaType, attributesSchema) + "\n\n")
}
for code, response := range operation.Responses {
var refPath, schemaType string
responseBodySchema := response.Content.ApplicationJSON.Schema
if responseBodySchema.Ref != "" {
schemaType = "object"
refPath = responseBodySchema.Ref
}
if responseBodySchema.Items.Ref != "" {
schemaType = "array"
refPath = responseBodySchema.Items.Ref
}
ref := strings.TrimPrefix(refPath, "#/components/schemas/")
sb.WriteString("+ Response " + code + " (application/json)\n")
responseSchema := componentSchemas[ref]
sb.WriteString(" + Body\n\n")
sb.WriteString(" " + formatBody(schemaType, responseSchema) + "\n\n")
}
sb.WriteString("\n")
return sb.String()
}
func createAPIBlueprint(api OpenAPI) (string, error) {
var sb strings.Builder
sb.WriteString("FORMAT: 1A\n")
sb.WriteString("HOST: http://api.example.com\n\n")
sb.WriteString("# " + api.Info.Title + "\n\n")
sortedPaths := make([]string, 0, len(api.Paths))
for path := range api.Paths {
sortedPaths = append(sortedPaths, path)
}
sort.Strings(sortedPaths)
var currentGroup string
for _, path := range sortedPaths {
methods := api.Paths[path]
for method, operation := range methods {
if len(operation.Tags) > 0 {
if operation.Tags[0] != currentGroup {
sb.WriteString("# Group " + operation.Tags[0] + "\n")
sb.WriteString("\nResources related to " + operation.Tags[0] + "\n\n")
}
currentGroup = operation.Tags[0]
}
sb.WriteString(formatOperation(method, path, operation, api.Components.Schemas))
}
}
return sb.String(), nil
}