Add basic OpenAPI implementation and the ability to export schemas
This commit is contained in:
Thilo Karraß
parent
ab7f4b60ba
commit
9afdada7e8
4
.gitignore
vendored
4
.gitignore
vendored
|
|
@ -35,3 +35,7 @@ opier
|
|||
*.swp
|
||||
*.flac
|
||||
.idea
|
||||
|
||||
# Do not check in test data
|
||||
*.yml
|
||||
*.yaml
|
||||
|
|
|
|||
83
cmd/generate.go
Normal file
83
cmd/generate.go
Normal file
|
|
@ -0,0 +1,83 @@
|
|||
package cmd // import "udico.de/uditaren/opier/cmd"
|
||||
import (
|
||||
log "github.com/sirupsen/logrus"
|
||||
"github.com/spf13/cobra"
|
||||
"io/ioutil"
|
||||
"os"
|
||||
"path"
|
||||
"strings"
|
||||
"udico.de/opier/encode"
|
||||
"udico.de/opier/openapi"
|
||||
)
|
||||
|
||||
var cGenerate = &cobra.Command{
|
||||
Use: "generate <input>",
|
||||
Short: "Generate Go code from a given input file",
|
||||
Long: `Generate Go code from a given input file, where <input> can either be a local
|
||||
or a remote file (when starting with http(s)://)`,
|
||||
|
||||
Args: cobra.ExactArgs(1),
|
||||
}
|
||||
|
||||
var packageName = "api"
|
||||
|
||||
func init() {
|
||||
cGenerate.RunE = executeGenerate
|
||||
cGenerate.PersistentFlags().StringVarP(&packageName, "package", "p","api", "The name of the generated package")
|
||||
|
||||
cRoot.AddCommand(cGenerate)
|
||||
}
|
||||
|
||||
func executeGenerate(cmd *cobra.Command, args []string) error {
|
||||
log.WithField("input", args[0]).Debugf("Generate Go code")
|
||||
|
||||
api, err := openapi.Load(args[0])
|
||||
if err != nil {
|
||||
log.WithError(err).Fatal("cannot load input data")
|
||||
}
|
||||
|
||||
log.Infof("API: %v, %v", api.Info.Title, api.Info.Version)
|
||||
log.Info("Paths:")
|
||||
for k, _ := range api.Paths {
|
||||
log.Infof(" - %v", k)
|
||||
for m, n := range api.Paths[k].Operations() {
|
||||
log.Infof( " [%v] %v: %v", m, n.OperationId, n.Summary)
|
||||
}
|
||||
}
|
||||
|
||||
os.Mkdir(packageName, 0755)
|
||||
os.Mkdir(path.Join(packageName, "schema"), 0755)
|
||||
tEnc := encode.NewEncoder(packageName)
|
||||
|
||||
log.Info("Types:")
|
||||
for k, v := range api.Components.Schemas {
|
||||
log.Infof("File: %v.go", strings.ToLower(k))
|
||||
tData := ""
|
||||
switch v.Type {
|
||||
case "array":
|
||||
//log.Infof(" [%v]", v.Items.TypeOrReference())
|
||||
tData = tEnc.Array(k, v)
|
||||
|
||||
case "object", "":
|
||||
tData = tEnc.Object(k, v)
|
||||
|
||||
default:
|
||||
if len(v.Enum) > 0 {
|
||||
tData = tEnc.Enum(k, v)
|
||||
} else {
|
||||
log.Warnf("UNKNOWN TYPE!!! %v , %v", k, v.Type)
|
||||
}
|
||||
}
|
||||
if tData == "" {
|
||||
log.Warnf("no data in %v", k)
|
||||
continue
|
||||
}
|
||||
err = ioutil.WriteFile(path.Join(packageName, k + ".go"), []byte(tData[:]) ,0644)
|
||||
if err != nil {
|
||||
log.WithError(err).Fatal("cannot create file")
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
31
cmd/root.go
Normal file
31
cmd/root.go
Normal file
|
|
@ -0,0 +1,31 @@
|
|||
package cmd // import "udico.de/uditaren/opier/cmd"
|
||||
|
||||
import (
|
||||
log "github.com/sirupsen/logrus"
|
||||
"github.com/spf13/cobra"
|
||||
)
|
||||
|
||||
var cRoot = &cobra.Command {
|
||||
Use: "opier <command>",
|
||||
Short: "Generate go code from OpenAPI YAML files",
|
||||
}
|
||||
|
||||
func init() {
|
||||
cRoot.PreRun = preexec
|
||||
cRoot.PostRun = postexec
|
||||
}
|
||||
|
||||
func Execute() {
|
||||
if err := cRoot.Execute(); err != nil {
|
||||
log.WithError(err).Fatal("top level oops")
|
||||
}
|
||||
}
|
||||
|
||||
func preexec(cmd *cobra.Command, args []string) {
|
||||
|
||||
}
|
||||
|
||||
func postexec(cmd *cobra.Command, args []string) {
|
||||
|
||||
}
|
||||
|
||||
22
encode/array.go
Normal file
22
encode/array.go
Normal file
|
|
@ -0,0 +1,22 @@
|
|||
package encode // import "udico.de/uditaren/opier/encode"
|
||||
import (
|
||||
"bytes"
|
||||
"fmt"
|
||||
"strings"
|
||||
"udico.de/opier/openapi"
|
||||
)
|
||||
|
||||
func (e Encoder) Array(name string, schema openapi.Schema) string {
|
||||
tBuf := bytes.Buffer{}
|
||||
tBuf.WriteString(fmt.Sprintf("package %v\n\n", e.Package))
|
||||
tBuf.WriteString(e.GeneratedHeader())
|
||||
|
||||
if schema.Description != "" {
|
||||
tDesc := strings.Split(strings.TrimSpace(schema.Description), "\n")
|
||||
for _, tLine := range tDesc {
|
||||
tBuf.WriteString(fmt.Sprintf("// %v\n", tLine))
|
||||
}
|
||||
}
|
||||
tBuf.WriteString(fmt.Sprintf("type %v []%v\n", name, schema.Items.GoType()))
|
||||
return tBuf.String()
|
||||
}
|
||||
43
encode/encoder.go
Normal file
43
encode/encoder.go
Normal file
|
|
@ -0,0 +1,43 @@
|
|||
package encode // import "udico.de/uditaren/opier/encode"
|
||||
import (
|
||||
"strings"
|
||||
"unicode"
|
||||
)
|
||||
|
||||
type Encoder struct {
|
||||
Package string
|
||||
}
|
||||
|
||||
func NewEncoder(pkg string) *Encoder {
|
||||
return &Encoder{
|
||||
Package: pkg,
|
||||
}
|
||||
}
|
||||
|
||||
// make
|
||||
func NormalizeName(aName string) string {
|
||||
tRet := &strings.Builder{}
|
||||
capitalizeNext := true
|
||||
for _, rune := range aName {
|
||||
if capitalizeNext {
|
||||
tRet.WriteRune(unicode.ToUpper(rune))
|
||||
capitalizeNext = false
|
||||
} else {
|
||||
if rune == '-' {
|
||||
capitalizeNext = true
|
||||
} else {
|
||||
tRet.WriteRune(rune)
|
||||
}
|
||||
}
|
||||
}
|
||||
return tRet.String()
|
||||
}
|
||||
|
||||
|
||||
func (e Encoder) GeneratedHeader() string {
|
||||
return`/***********************************************
|
||||
*** This is a GENERATED file - Do not edit! ***
|
||||
***********************************************/
|
||||
|
||||
`
|
||||
}
|
||||
40
encode/enum.go
Normal file
40
encode/enum.go
Normal file
|
|
@ -0,0 +1,40 @@
|
|||
package encode // import "udico.de/uditaren/opier/encode"
|
||||
import (
|
||||
"bytes"
|
||||
"fmt"
|
||||
"strings"
|
||||
"udico.de/opier/openapi"
|
||||
)
|
||||
|
||||
func (e Encoder) Enum(name string, schema openapi.Schema) string {
|
||||
tBuf := bytes.Buffer{}
|
||||
tBuf.WriteString(fmt.Sprintf("package %v\n\n", e.Package))
|
||||
tBuf.WriteString(e.GeneratedHeader())
|
||||
|
||||
if schema.Description != "" {
|
||||
tDesc := strings.Split(strings.TrimSpace(schema.Description), "\n")
|
||||
for _, tLine := range tDesc {
|
||||
tBuf.WriteString(fmt.Sprintf("// %v\n", tLine))
|
||||
}
|
||||
}
|
||||
tBuf.WriteString(fmt.Sprintf("type %v %v\n\n", name, schema.Type))
|
||||
tBuf.WriteString(fmt.Sprintf("const (\n"))
|
||||
|
||||
firstRow := true
|
||||
tNames, tLen := schema.EnumNames()
|
||||
tLenName := len(name)
|
||||
for k, v := range schema.Enum {
|
||||
value := v
|
||||
if schema.Type == "string" {
|
||||
value = fmt.Sprintf("\"%v\"", v)
|
||||
}
|
||||
if firstRow {
|
||||
tBuf.WriteString(fmt.Sprintf(" %[2]v_%-[4]*[1]v %v = %v\n", tNames[k], name, value, tLen))
|
||||
firstRow = false
|
||||
} else {
|
||||
tBuf.WriteString(fmt.Sprintf(" %[2]v_%-[4]*[1]v %[5]*[6]v = %[3]v\n", tNames[k], name, value, tLen, tLenName, ""))
|
||||
}
|
||||
}
|
||||
tBuf.WriteString(fmt.Sprintf(")\n"))
|
||||
return tBuf.String()
|
||||
}
|
||||
38
encode/object.go
Normal file
38
encode/object.go
Normal file
|
|
@ -0,0 +1,38 @@
|
|||
package encode // import "udico.de/uditaren/opier/encode"
|
||||
import (
|
||||
"bytes"
|
||||
"fmt"
|
||||
"strings"
|
||||
"udico.de/opier/openapi"
|
||||
)
|
||||
|
||||
func (e Encoder) Object(name string, schema openapi.Schema) string {
|
||||
|
||||
tBuf := bytes.Buffer{}
|
||||
tBuf.WriteString(fmt.Sprintf("package %v\n\n", e.Package))
|
||||
tBuf.WriteString(e.GeneratedHeader())
|
||||
|
||||
if schema.Description != "" {
|
||||
tDesc := strings.Split(strings.TrimSpace(schema.Description), "\n")
|
||||
for _, tLine := range tDesc {
|
||||
tBuf.WriteString(fmt.Sprintf("// %v\n", tLine))
|
||||
}
|
||||
}
|
||||
tBuf.WriteString(fmt.Sprintf("type %v struct {\n", name))
|
||||
|
||||
for k, v := range schema.Properties {
|
||||
tName := NormalizeName(k)
|
||||
if v.Description != "" {
|
||||
tDesc := strings.Split(strings.TrimSpace(v.Description), "\n")
|
||||
tBuf.WriteString(fmt.Sprintf("\n")) // just a newline before commented fields
|
||||
for _, tLine := range tDesc {
|
||||
tBuf.WriteString(fmt.Sprintf(" // %v\n", tLine))
|
||||
}
|
||||
}
|
||||
tBuf.WriteString(fmt.Sprintf(" %v %v `json:\"%v\"`\n", tName, v.GoType(), k))
|
||||
}
|
||||
|
||||
tBuf.WriteString(fmt.Sprintf("}\n"))
|
||||
|
||||
return tBuf.String()
|
||||
}
|
||||
7
go.mod
7
go.mod
|
|
@ -1,3 +1,10 @@
|
|||
module udico.de/opier
|
||||
|
||||
go 1.14
|
||||
|
||||
require (
|
||||
github.com/sirupsen/logrus v1.6.0
|
||||
github.com/spf13/cobra v1.0.0
|
||||
gopkg.in/yaml.v2 v2.3.0
|
||||
gopkg.in/yaml.v3 v3.0.0-20200615113413-eeeca48fe776
|
||||
)
|
||||
|
|
|
|||
137
go.sum
Normal file
137
go.sum
Normal file
|
|
@ -0,0 +1,137 @@
|
|||
cloud.google.com/go v0.26.0/go.mod h1:aQUYkXzVsufM+DwF1aE+0xfcU+56JwCaLick0ClmMTw=
|
||||
github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
|
||||
github.com/OneOfOne/xxhash v1.2.2/go.mod h1:HSdplMjZKSmBqAxg5vPj2TmRDmfkzw+cTzAElWljhcU=
|
||||
github.com/alecthomas/template v0.0.0-20160405071501-a0175ee3bccc/go.mod h1:LOuyumcjzFXgccqObfd/Ljyb9UuFJ6TxHnclSeseNhc=
|
||||
github.com/alecthomas/units v0.0.0-20151022065526-2efee857e7cf/go.mod h1:ybxpYRFXyAe+OPACYpWeL0wqObRcbAqCMya13uyzqw0=
|
||||
github.com/armon/consul-api v0.0.0-20180202201655-eb2c6b5be1b6/go.mod h1:grANhF5doyWs3UAsr3K4I6qtAmlQcZDesFNEHPZAzj8=
|
||||
github.com/beorn7/perks v0.0.0-20180321164747-3a771d992973/go.mod h1:Dwedo/Wpr24TaqPxmxbtue+5NUziq4I4S80YR8gNf3Q=
|
||||
github.com/beorn7/perks v1.0.0/go.mod h1:KWe93zE9D1o94FZ5RNwFwVgaQK1VOXiVxmqh+CedLV8=
|
||||
github.com/cespare/xxhash v1.1.0/go.mod h1:XrSqR1VqqWfGrhpAt58auRo0WTKS1nRRg3ghfAqPWnc=
|
||||
github.com/client9/misspell v0.3.4/go.mod h1:qj6jICC3Q7zFZvVWo7KLAzC3yx5G7kyvSDkc90ppPyw=
|
||||
github.com/coreos/bbolt v1.3.2/go.mod h1:iRUV2dpdMOn7Bo10OQBFzIJO9kkE559Wcmn+qkEiiKk=
|
||||
github.com/coreos/etcd v3.3.10+incompatible/go.mod h1:uF7uidLiAD3TWHmW31ZFd/JWoc32PjwdhPthX9715RE=
|
||||
github.com/coreos/go-semver v0.2.0/go.mod h1:nnelYz7RCh+5ahJtPPxZlU+153eP4D4r3EedlOD2RNk=
|
||||
github.com/coreos/go-systemd v0.0.0-20190321100706-95778dfbb74e/go.mod h1:F5haX7vjVVG0kc13fIWeqUViNPyEJxv/OmvnBo0Yme4=
|
||||
github.com/coreos/pkg v0.0.0-20180928190104-399ea9e2e55f/go.mod h1:E3G3o1h8I7cfcXa63jLwjI0eiQQMgzzUDFVpN/nH/eA=
|
||||
github.com/cpuguy83/go-md2man/v2 v2.0.0/go.mod h1:maD7wRr/U5Z6m/iR4s+kqSMx2CaBsrgA7czyZG/E6dU=
|
||||
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
||||
github.com/dgrijalva/jwt-go v3.2.0+incompatible/go.mod h1:E3ru+11k8xSBh+hMPgOLZmtrrCbhqsmaPHjLKYnJCaQ=
|
||||
github.com/dgryski/go-sip13 v0.0.0-20181026042036-e10d5fee7954/go.mod h1:vAd38F8PWV+bWy6jNmig1y/TA+kYO4g3RSRF0IAv0no=
|
||||
github.com/fsnotify/fsnotify v1.4.7/go.mod h1:jwhsz4b93w/PPRr/qN1Yymfu8t87LnFCMoQvtojpjFo=
|
||||
github.com/ghodss/yaml v1.0.0/go.mod h1:4dBDuWmgqj2HViK6kFavaiC9ZROes6MMH2rRYeMEF04=
|
||||
github.com/go-kit/kit v0.8.0/go.mod h1:xBxKIO96dXMWWy0MnWVtmwkA9/13aqxPnvrjFYMA2as=
|
||||
github.com/go-logfmt/logfmt v0.3.0/go.mod h1:Qt1PoO58o5twSAckw1HlFXLmHsOX5/0LbT9GBnD5lWE=
|
||||
github.com/go-logfmt/logfmt v0.4.0/go.mod h1:3RMwSq7FuexP4Kalkev3ejPJsZTpXXBr9+V4qmtdjCk=
|
||||
github.com/go-stack/stack v1.8.0/go.mod h1:v0f6uXyyMGvRgIKkXu+yp6POWl0qKG85gN/melR3HDY=
|
||||
github.com/gogo/protobuf v1.1.1/go.mod h1:r8qH/GZQm5c6nD/R0oafs1akxWv10x8SbQlK7atdtwQ=
|
||||
github.com/gogo/protobuf v1.2.1/go.mod h1:hp+jE20tsWTFYpLwKvXlhS1hjn+gTNwPg2I6zVXpSg4=
|
||||
github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b/go.mod h1:SBH7ygxi8pfUlaOkMMuAQtPIUF8ecWP5IEl/CR7VP2Q=
|
||||
github.com/golang/groupcache v0.0.0-20190129154638-5b532d6fd5ef/go.mod h1:cIg4eruTrX1D+g88fzRXU5OdNfaM+9IcxsU14FzY7Hc=
|
||||
github.com/golang/mock v1.1.1/go.mod h1:oTYuIxOrZwtPieC+H1uAHpcLFnEyAGVDL/k47Jfbm0A=
|
||||
github.com/golang/protobuf v1.2.0/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U=
|
||||
github.com/golang/protobuf v1.3.1/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U=
|
||||
github.com/google/btree v1.0.0/go.mod h1:lNA+9X1NB3Zf8V7Ke586lFgjr2dZNuvo3lPJSGZ5JPQ=
|
||||
github.com/google/go-cmp v0.2.0/go.mod h1:oXzfMopK8JAjlY9xF4vHSVASa0yLyX7SntLO5aqRK0M=
|
||||
github.com/gorilla/websocket v1.4.0/go.mod h1:E7qHFY5m1UJ88s3WnNqhKjPHQ0heANvMoAMk2YaljkQ=
|
||||
github.com/grpc-ecosystem/go-grpc-middleware v1.0.0/go.mod h1:FiyG127CGDf3tlThmgyCl78X/SZQqEOJBCDaAfeWzPs=
|
||||
github.com/grpc-ecosystem/go-grpc-prometheus v1.2.0/go.mod h1:8NvIoxWQoOIhqOTXgfV/d3M/q6VIi02HzZEHgUlZvzk=
|
||||
github.com/grpc-ecosystem/grpc-gateway v1.9.0/go.mod h1:vNeuVxBJEsws4ogUvrchl83t/GYV9WGTSLVdBhOQFDY=
|
||||
github.com/hashicorp/hcl v1.0.0/go.mod h1:E5yfLk+7swimpb2L/Alb/PJmXilQ/rhwaUYs4T20WEQ=
|
||||
github.com/inconshreveable/mousetrap v1.0.0 h1:Z8tu5sraLXCXIcARxBp/8cbvlwVa7Z1NHg9XEKhtSvM=
|
||||
github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANytuPF1OarO4DADm73n8=
|
||||
github.com/jonboulle/clockwork v0.1.0/go.mod h1:Ii8DK3G1RaLaWxj9trq07+26W01tbo22gdxWY5EU2bo=
|
||||
github.com/julienschmidt/httprouter v1.2.0/go.mod h1:SYymIcj16QtmaHHD7aYtjjsJG7VTCxuUUipMqKk8s4w=
|
||||
github.com/kisielk/errcheck v1.1.0/go.mod h1:EZBBE59ingxPouuu3KfxchcWSUPOHkagtvWXihfKN4Q=
|
||||
github.com/kisielk/gotool v1.0.0/go.mod h1:XhKaO+MFFWcvkIS/tQcRk01m1F5IRFswLeQ+oQHNcck=
|
||||
github.com/konsorten/go-windows-terminal-sequences v1.0.1/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ=
|
||||
github.com/konsorten/go-windows-terminal-sequences v1.0.3 h1:CE8S1cTafDpPvMhIxNJKvHsGVBgn1xWYf1NbHQhywc8=
|
||||
github.com/konsorten/go-windows-terminal-sequences v1.0.3/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ=
|
||||
github.com/kr/logfmt v0.0.0-20140226030751-b84e30acd515/go.mod h1:+0opPa2QZZtGFBFZlji/RkVcI2GknAs/DXo4wKdlNEc=
|
||||
github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo=
|
||||
github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
|
||||
github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
|
||||
github.com/magiconair/properties v1.8.0/go.mod h1:PppfXfuXeibc/6YijjN8zIbojt8czPbwD3XqdrwzmxQ=
|
||||
github.com/matttproud/golang_protobuf_extensions v1.0.1/go.mod h1:D8He9yQNgCq6Z5Ld7szi9bcBfOoFv/3dc6xSMkL2PC0=
|
||||
github.com/mitchellh/go-homedir v1.1.0/go.mod h1:SfyaCUpYCn1Vlf4IUYiD9fPX4A5wJrkLzIz1N1q0pr0=
|
||||
github.com/mitchellh/mapstructure v1.1.2/go.mod h1:FVVH3fgwuzCH5S8UJGiWEs2h04kUh9fWfEaFds41c1Y=
|
||||
github.com/mwitkow/go-conntrack v0.0.0-20161129095857-cc309e4a2223/go.mod h1:qRWi+5nqEBWmkhHvq77mSJWrCKwh8bxhgT7d/eI7P4U=
|
||||
github.com/oklog/ulid v1.3.1/go.mod h1:CirwcVhetQ6Lv90oh/F+FBtV6XMibvdAFo93nm5qn4U=
|
||||
github.com/pelletier/go-toml v1.2.0/go.mod h1:5z9KED0ma1S8pY6P1sdut58dfprrGBbd/94hg7ilaic=
|
||||
github.com/pkg/errors v0.8.0/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
|
||||
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
|
||||
github.com/prometheus/client_golang v0.9.1/go.mod h1:7SWBe2y4D6OKWSNQJUaRYU/AaXPKyh/dDVn+NZz0KFw=
|
||||
github.com/prometheus/client_golang v0.9.3/go.mod h1:/TN21ttK/J9q6uSwhBd54HahCDft0ttaMvbicHlPoso=
|
||||
github.com/prometheus/client_model v0.0.0-20180712105110-5c3871d89910/go.mod h1:MbSGuTsp3dbXC40dX6PRTWyKYBIrTGTE9sqQNg2J8bo=
|
||||
github.com/prometheus/client_model v0.0.0-20190129233127-fd36f4220a90/go.mod h1:xMI15A0UPsDsEKsMN9yxemIoYk6Tm2C1GtYGdfGttqA=
|
||||
github.com/prometheus/common v0.0.0-20181113130724-41aa239b4cce/go.mod h1:daVV7qP5qjZbuso7PdcryaAu0sAZbrN9i7WWcTMWvro=
|
||||
github.com/prometheus/common v0.4.0/go.mod h1:TNfzLD0ON7rHzMJeJkieUDPYmFC7Snx/y86RQel1bk4=
|
||||
github.com/prometheus/procfs v0.0.0-20181005140218-185b4288413d/go.mod h1:c3At6R/oaqEKCNdg8wHV1ftS6bRYblBhIjjI8uT2IGk=
|
||||
github.com/prometheus/procfs v0.0.0-20190507164030-5867b95ac084/go.mod h1:TjEm7ze935MbeOT/UhFTIMYKhuLP4wbCsTZCD3I8kEA=
|
||||
github.com/prometheus/tsdb v0.7.1/go.mod h1:qhTCs0VvXwvX/y3TZrWD7rabWM+ijKTux40TwIPHuXU=
|
||||
github.com/rogpeppe/fastuuid v0.0.0-20150106093220-6724a57986af/go.mod h1:XWv6SoW27p1b0cqNHllgS5HIMJraePCO15w5zCzIWYg=
|
||||
github.com/russross/blackfriday/v2 v2.0.1/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
|
||||
github.com/shurcooL/sanitized_anchor_name v1.0.0/go.mod h1:1NzhyTcUVG4SuEtjjoZeVRXNmyL/1OwPU0+IJeTBvfc=
|
||||
github.com/sirupsen/logrus v1.2.0/go.mod h1:LxeOpSwHxABJmUn/MG1IvRgCAasNZTLOkJPxbbu5VWo=
|
||||
github.com/sirupsen/logrus v1.6.0 h1:UBcNElsrwanuuMsnGSlYmtmgbb23qDR5dG+6X6Oo89I=
|
||||
github.com/sirupsen/logrus v1.6.0/go.mod h1:7uNnSEd1DgxDLC74fIahvMZmmYsHGZGEOFrfsX/uA88=
|
||||
github.com/soheilhy/cmux v0.1.4/go.mod h1:IM3LyeVVIOuxMH7sFAkER9+bJ4dT7Ms6E4xg4kGIyLM=
|
||||
github.com/spaolacci/murmur3 v0.0.0-20180118202830-f09979ecbc72/go.mod h1:JwIasOWyU6f++ZhiEuf87xNszmSA2myDM2Kzu9HwQUA=
|
||||
github.com/spf13/afero v1.1.2/go.mod h1:j4pytiNVoe2o6bmDsKpLACNPDBIoEAkihy7loJ1B0CQ=
|
||||
github.com/spf13/cast v1.3.0/go.mod h1:Qx5cxh0v+4UWYiBimWS+eyWzqEqokIECu5etghLkUJE=
|
||||
github.com/spf13/cobra v1.0.0 h1:6m/oheQuQ13N9ks4hubMG6BnvwOeaJrqSPLahSnczz8=
|
||||
github.com/spf13/cobra v1.0.0/go.mod h1:/6GTrnGXV9HjY+aR4k0oJ5tcvakLuG6EuKReYlHNrgE=
|
||||
github.com/spf13/jwalterweatherman v1.0.0/go.mod h1:cQK4TGJAtQXfYWX+Ddv3mKDzgVb68N+wFjFa4jdeBTo=
|
||||
github.com/spf13/pflag v1.0.3 h1:zPAT6CGy6wXeQ7NtTnaTerfKOsV6V6F8agHXFiazDkg=
|
||||
github.com/spf13/pflag v1.0.3/go.mod h1:DYY7MBk1bdzusC3SYhjObp+wFpr4gzcvqqNjLnInEg4=
|
||||
github.com/spf13/viper v1.4.0/go.mod h1:PTJ7Z/lr49W6bUbkmS1V3by4uWynFiR9p7+dSq/yZzE=
|
||||
github.com/stretchr/objx v0.1.1/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
|
||||
github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
|
||||
github.com/tmc/grpc-websocket-proxy v0.0.0-20190109142713-0ad062ec5ee5/go.mod h1:ncp9v5uamzpCO7NfCPTXjqaC+bZgJeR0sMTm6dMHP7U=
|
||||
github.com/ugorji/go v1.1.4/go.mod h1:uQMGLiO92mf5W77hV/PUCpI3pbzQx3CRekS0kk+RGrc=
|
||||
github.com/xiang90/probing v0.0.0-20190116061207-43a291ad63a2/go.mod h1:UETIi67q53MR2AWcXfiuqkDkRtnGDLqkBTpCHuJHxtU=
|
||||
github.com/xordataexchange/crypt v0.0.3-0.20170626215501-b2862e3d0a77/go.mod h1:aYKd//L2LvnjZzWKhF00oedf4jCCReLcmhLdhm1A27Q=
|
||||
go.etcd.io/bbolt v1.3.2/go.mod h1:IbVyRI1SCnLcuJnV2u8VeU0CEYM7e686BmAb1XKL+uU=
|
||||
go.uber.org/atomic v1.4.0/go.mod h1:gD2HeocX3+yG+ygLZcrzQJaqmWj9AIm7n08wl/qW/PE=
|
||||
go.uber.org/multierr v1.1.0/go.mod h1:wR5kodmAFQ0UK8QlbwjlSNy0Z68gJhDJUG5sjR94q/0=
|
||||
go.uber.org/zap v1.10.0/go.mod h1:vwi/ZaCAaUcBkycHslxD9B2zi4UTXhF60s6SWpuDF0Q=
|
||||
golang.org/x/crypto v0.0.0-20180904163835-0709b304e793/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4=
|
||||
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
|
||||
golang.org/x/lint v0.0.0-20181026193005-c67002cb31c3/go.mod h1:UVdnD1Gm6xHRNCYTkRU2/jEulfH38KcIWyp/GAMgvoE=
|
||||
golang.org/x/lint v0.0.0-20190313153728-d0100b6bd8b3/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc=
|
||||
golang.org/x/net v0.0.0-20180826012351-8a410e7b638d/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
|
||||
golang.org/x/net v0.0.0-20181114220301-adae6a3d119a/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
|
||||
golang.org/x/net v0.0.0-20181220203305-927f97764cc3/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
|
||||
golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
|
||||
golang.org/x/net v0.0.0-20190522155817-f3200d17e092/go.mod h1:HSz+uSET+XFnRR8LxR5pz3Of3rY3CfYBVs4xY44aLks=
|
||||
golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U=
|
||||
golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
||||
golang.org/x/sync v0.0.0-20181108010431-42b317875d0f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
||||
golang.org/x/sync v0.0.0-20181221193216-37e7f081c4d4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
||||
golang.org/x/sys v0.0.0-20180830151530-49385e6e1522/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
|
||||
golang.org/x/sys v0.0.0-20180905080454-ebe1bf3edb33/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
|
||||
golang.org/x/sys v0.0.0-20181107165924-66b7b1311ac8/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
|
||||
golang.org/x/sys v0.0.0-20181116152217-5ac8a444bdc5/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
|
||||
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
|
||||
golang.org/x/sys v0.0.0-20190422165155-953cdadca894 h1:Cz4ceDQGXuKRnVBDTS23GTn/pU5OE2C0WrNTOYK1Uuc=
|
||||
golang.org/x/sys v0.0.0-20190422165155-953cdadca894/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
|
||||
golang.org/x/time v0.0.0-20190308202827-9d24e82272b4/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ=
|
||||
golang.org/x/tools v0.0.0-20180221164845-07fd8470d635/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
|
||||
golang.org/x/tools v0.0.0-20190114222345-bf090417da8b/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
|
||||
golang.org/x/tools v0.0.0-20190311212946-11955173bddd/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs=
|
||||
google.golang.org/appengine v1.1.0/go.mod h1:EbEs0AVv82hx2wNQdGPgUI5lhzA/G0D9YwlJXL52JkM=
|
||||
google.golang.org/genproto v0.0.0-20180817151627-c66870c02cf8/go.mod h1:JiN7NxoALGmiZfu7CAH4rXhgtRTLTxftemlI0sWmxmc=
|
||||
google.golang.org/grpc v1.19.0/go.mod h1:mqu4LbDTu4XGKhr4mRzUsmM4RtVoemTSY81AxZiDr8c=
|
||||
google.golang.org/grpc v1.21.0/go.mod h1:oYelfM1adQP15Ek0mdvEgi9Df8B9CZIaU1084ijfRaM=
|
||||
gopkg.in/alecthomas/kingpin.v2 v2.2.6/go.mod h1:FMv+mEhP44yOT+4EoQTLFTRgOQ1FBLkstjWtayDeSgw=
|
||||
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
||||
gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
||||
gopkg.in/resty.v1 v1.12.0/go.mod h1:mDo4pnntr5jdWRML875a/NmxYqAlA73dVijT2AXvQQo=
|
||||
gopkg.in/yaml.v2 v2.0.0-20170812160011-eb3733d160e7/go.mod h1:JAlM8MvJe8wmxCU4Bli9HhUf9+ttbYbLASfIpnQbh74=
|
||||
gopkg.in/yaml.v2 v2.2.1/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
|
||||
gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
|
||||
gopkg.in/yaml.v2 v2.3.0 h1:clyUAQHOM3G0M3f5vQj7LuJrETvjVot3Z5el9nffUtU=
|
||||
gopkg.in/yaml.v2 v2.3.0/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
|
||||
gopkg.in/yaml.v3 v3.0.0-20200615113413-eeeca48fe776 h1:tQIYjPdBoyREyB9XMu+nnTclpTYkz2zFM+lzLJFO4gQ=
|
||||
gopkg.in/yaml.v3 v3.0.0-20200615113413-eeeca48fe776/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
||||
honnef.co/go/tools v0.0.0-20190102054323-c2f93a96b099/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=
|
||||
261
openapi/openapi.go
Normal file
261
openapi/openapi.go
Normal file
|
|
@ -0,0 +1,261 @@
|
|||
package openapi // import "udico.de/uditaren/opier/openapi"
|
||||
import (
|
||||
"fmt"
|
||||
"gopkg.in/yaml.v3"
|
||||
"os"
|
||||
"strings"
|
||||
"unicode"
|
||||
)
|
||||
|
||||
type OpenAPI struct {
|
||||
Version string `yaml:"openapi"`
|
||||
Info struct {
|
||||
Title string
|
||||
Version string
|
||||
Description string
|
||||
}
|
||||
Paths map[string]*PathItem `yaml:"paths"`
|
||||
|
||||
Components *Components
|
||||
}
|
||||
|
||||
func Load(fname string) (*OpenAPI, error) {
|
||||
f, err := os.Open(fname)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
tRet := &OpenAPI{}
|
||||
tY := yaml.NewDecoder(f)
|
||||
err = tY.Decode(tRet)
|
||||
return tRet, err
|
||||
}
|
||||
|
||||
// PathItem Describes the operations available on a single path. A Path Item MAY be empty, due to ACL constraints.
|
||||
// The path itself is still exposed to the documentation viewer but they will not know which operations and parameters
|
||||
// are available.
|
||||
type PathItem struct {
|
||||
|
||||
// Allows for an external definition of this path item. The referenced structure MUST be in the format of a
|
||||
// PathItem Object. In case a PathItem Object field appears both in the defined object and the referenced object,
|
||||
// the behavior is undefined.
|
||||
Ref string `yaml:"$ref"`
|
||||
|
||||
// An optional, string summary, intended to apply to all operations in this path.
|
||||
Summary string
|
||||
|
||||
// An optional, string description, intended to apply to all operations in this path. CommonMark syntax MAY be
|
||||
// used for rich text representation.
|
||||
Description string
|
||||
|
||||
Get *Operation
|
||||
Put *Operation
|
||||
Post *Operation
|
||||
Delete *Operation
|
||||
Options *Operation
|
||||
Head *Operation
|
||||
Patch *Operation
|
||||
Trace *Operation
|
||||
}
|
||||
|
||||
func (p PathItem) Operations() map[string]*Operation {
|
||||
tRet := make(map[string]*Operation)
|
||||
if p.Get != nil {
|
||||
tRet["get"] = p.Get
|
||||
}
|
||||
if p.Put != nil {
|
||||
tRet["put"] = p.Put
|
||||
}
|
||||
if p.Post != nil {
|
||||
tRet["post"] = p.Post
|
||||
}
|
||||
if p.Delete != nil {
|
||||
tRet["delete"] = p.Delete
|
||||
}
|
||||
if p.Options != nil {
|
||||
tRet["options"] = p.Options
|
||||
}
|
||||
if p.Head != nil {
|
||||
tRet["head"] = p.Head
|
||||
}
|
||||
if p.Patch != nil {
|
||||
tRet["patch"] = p.Patch
|
||||
}
|
||||
if p.Trace != nil {
|
||||
tRet["trace"] = p.Trace
|
||||
}
|
||||
return tRet
|
||||
}
|
||||
|
||||
// Operation describes a single API operation on a path.
|
||||
type Operation struct {
|
||||
// A list of tags for API documentation control. Tags can be used for logical grouping of operations
|
||||
// by resources or any other qualifier.
|
||||
Tags []string
|
||||
|
||||
// A short summary of what the operation does.
|
||||
Summary string
|
||||
|
||||
// A verbose explanation of the operation behavior. CommonMark syntax MAY be used for rich text representation.
|
||||
Description string
|
||||
|
||||
// Additional external documentation for this operation.
|
||||
//externalDocs
|
||||
|
||||
// Unique string used to identify the operation. The id MUST be unique among all operations described in the API.
|
||||
// The operationId value is case-sensitive. Tools and libraries MAY use the operationId to uniquely identify an
|
||||
// operation, therefore, it is RECOMMENDED to follow common programming naming conventions.
|
||||
OperationId string `yaml:"operationId"`
|
||||
|
||||
//Parameters [] ...
|
||||
// requestBodyesObject // required
|
||||
// callba
|
||||
// Responses Responscks
|
||||
Deprecated bool
|
||||
|
||||
// A declaration of which security mechanisms can be used for this operation.
|
||||
// The list of values includes alternative security requirement objects that can be used. Only one of the security
|
||||
// requirement objects need to be satisfied to authorize a request. To make security optional, an empty security
|
||||
// requirement ({}) can be included in the array. This definition overrides any declared top-level security.
|
||||
// To remove a top-level security declaration, an empty array can be used.
|
||||
Security []map[string][]string `yaml:"security"`
|
||||
|
||||
// An alternative server array to service this operation. If an alternative server object is specified at the Path
|
||||
// Item Object or Root level, it will be overridden by this value.
|
||||
// Servers
|
||||
}
|
||||
|
||||
type ResponsesObject struct {
|
||||
// ...
|
||||
}
|
||||
|
||||
type Components struct {
|
||||
//SecuritySchemas
|
||||
//Responses map[string, ResponseObject]
|
||||
Parameters map[string]Parameter
|
||||
Schemas map[string]Schema
|
||||
}
|
||||
|
||||
type ParameterLocation string
|
||||
|
||||
const (
|
||||
QUERY ParameterLocation = "query"
|
||||
HEAD = "header"
|
||||
PATH = "path"
|
||||
COOKIE = "cookie"
|
||||
)
|
||||
|
||||
type Parameter struct {
|
||||
|
||||
// only if this a reference object instead of a parameter obect
|
||||
Ref string `yaml:"$ref"`
|
||||
|
||||
Name string
|
||||
In ParameterLocation
|
||||
Description string
|
||||
Required bool
|
||||
Deprecated bool
|
||||
AllowEmptyValue bool `yaml:"allowEmptyValue"`
|
||||
|
||||
///--- either
|
||||
|
||||
Style string
|
||||
Explode bool
|
||||
AllowReserved bool `yaml:"allowReserved"`
|
||||
Schema *Schema
|
||||
// example
|
||||
// examples
|
||||
|
||||
///--- or
|
||||
Content map[string]*MediaType
|
||||
}
|
||||
|
||||
type Schema struct {
|
||||
// may be a schema reference:
|
||||
Ref string `yaml:"$ref"`
|
||||
|
||||
Type string
|
||||
// when type==array:
|
||||
Items *Schema
|
||||
// when type==object
|
||||
Properties map[string]*Schema
|
||||
|
||||
Format string
|
||||
Minimum int
|
||||
Maximum int
|
||||
Default interface{}
|
||||
|
||||
Enum []interface{}
|
||||
XEnumVarnames []string `yaml:"x-enum-varnames"`
|
||||
|
||||
Required []string
|
||||
Description string
|
||||
}
|
||||
|
||||
func (s Schema) TypeOrReference() string {
|
||||
if s.Ref != "" {
|
||||
return s.Ref
|
||||
}
|
||||
return s.Type
|
||||
}
|
||||
|
||||
func (s Schema) GoType() string {
|
||||
tRet := s.Type
|
||||
if s.Ref != "" {
|
||||
idx := strings.LastIndex(s.Ref, "/")
|
||||
tRet = "*" + s.Ref[idx+1:]
|
||||
} else {
|
||||
switch s.Type {
|
||||
case "integer":
|
||||
tRet = "int"
|
||||
case "boolean":
|
||||
tRet = "bool"
|
||||
case "array":
|
||||
tRet = fmt.Sprintf("[]%v", s.Items.GoType())
|
||||
}
|
||||
}
|
||||
return tRet
|
||||
}
|
||||
|
||||
// EnumNames returns the String representations for this enums values and the length of the longest name as well.
|
||||
func (s Schema) EnumNames() ([]string, int) {
|
||||
tLen := 0
|
||||
tRet := make([]string, len(s.Enum), len(s.Enum))
|
||||
for k, v := range s.Enum {
|
||||
tName := NormalizeName(fmt.Sprintf("%v", v))
|
||||
if len(s.XEnumVarnames) == len(s.Enum) {
|
||||
// read the desired enum name instead
|
||||
tName = s.XEnumVarnames[k]
|
||||
}
|
||||
tRet[k] = tName
|
||||
if len(tName) > tLen {
|
||||
tLen = len(tName)
|
||||
}
|
||||
}
|
||||
return tRet, tLen
|
||||
}
|
||||
|
||||
type Referencable interface {
|
||||
|
||||
}
|
||||
|
||||
type MediaType struct {
|
||||
|
||||
}
|
||||
|
||||
func NormalizeName(aName string) string {
|
||||
tRet := &strings.Builder{}
|
||||
capitalizeNext := true
|
||||
for _, rune := range aName {
|
||||
if capitalizeNext {
|
||||
tRet.WriteRune(unicode.ToUpper(rune))
|
||||
capitalizeNext = false
|
||||
} else {
|
||||
if rune == '-' {
|
||||
capitalizeNext = true
|
||||
} else {
|
||||
tRet.WriteRune(rune)
|
||||
}
|
||||
}
|
||||
}
|
||||
return tRet.String()
|
||||
}
|
||||
Loading…
Reference in New Issue
Block a user