grafana/scripts/openapi3/openapi3conv.go
2026-02-26 13:03:02 +00:00

103 lines
2.3 KiB
Go

package main
import (
"encoding/json"
"fmt"
"os"
"strings"
"github.com/getkin/kin-openapi/openapi2"
"github.com/getkin/kin-openapi/openapi2conv"
"github.com/getkin/kin-openapi/openapi3"
)
// main This simple script will take the swagger v2 spec generated by grafana and convert them into openapi 3
// saving them as new json file to be able lo load and show
// The first parameter, if present, will be the input file
// The second parameter, if present, will be the output file
func main() {
outFile := "public/openapi3.json"
inFile := "api-merged.json"
args := os.Args[1:]
// first parameter as the input
if len(args) > 0 && args[0] != "" {
inFile = args[0]
}
// Post process the swagger files
if inFile == "cleanup" {
for _, f := range os.Args[2:] {
postProcessSwaggerFile(f)
}
return
}
// second parameter as output
if len(args) > 1 && args[1] != "" {
outFile = args[1]
}
fmt.Printf("Reading swagger 2 file %s\n", inFile)
byt, err := os.ReadFile(inFile)
if err != nil {
panic(err)
}
var doc2 openapi2.T
if err = json.Unmarshal(byt, &doc2); err != nil {
panic(err)
}
doc3, err := openapi2conv.ToV3(&doc2)
if err != nil {
panic(err)
}
// this is a workaround. In the swagger2 specs there ir no definition of the host, so the converter can not create
// a URL. Adding this will ensure that all the api calls start with "/api".
doc3.AddServer(&openapi3.Server{URL: "/api"})
j3, err := json.MarshalIndent(doc3, "", " ")
if err != nil {
panic(err)
}
if err = os.WriteFile(outFile, j3, 0644); err != nil {
panic(err)
}
fmt.Printf("OpenAPI specs generated in file %s\n", outFile)
}
func postProcessSwaggerFile(inFile string) {
fmt.Printf("Reading swagger file %s\n", inFile)
byt, err := os.ReadFile(inFile)
if err != nil {
panic(err)
}
jj := string(byt)
var processed string
// Replace the URL property
idx := strings.Index(jj, ` "URL": {`)
if idx > 0 {
after := jj[idx:]
edx := strings.Index(after, `"Unstructured": {`)
if edx > 0 {
processed = jj[0:idx] + ` "URL": {
"type": "string",
"format": "url"
},
` + after[edx:]
}
}
if len(processed) > 0 {
if err = os.WriteFile(inFile, []byte(processed), 0644); err != nil {
panic(err)
}
fmt.Printf("Processed file %s\n", inFile)
return
}
fmt.Printf("Nothing found in file %s\n", inFile)
}