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
|
// Package openapi2 parses and writes OpenAPI 2 specifications.
//
// Does not cover all elements of OpenAPI 2.
// When OpenAPI version 3 is backwards-compatible with version 2, version 3 elements have been used.
//
// The specification:
// https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md
package openapi2
import (
"fmt"
"github.com/getkin/kin-openapi/openapi3"
)
type Swagger struct {
Info openapi3.Info `json:"info"`
ExternalDocs *openapi3.ExternalDocs `json:"externalDocs,omitempty"`
Schemes []string `json:"schemas,omitempty"`
Host string `json:"host,omitempty"`
BasePath string `json:"basePath,omitempty"`
Paths map[string]*PathItem `json:"paths,omitempty"`
Definitions map[string]*openapi3.SchemaRef `json:"definitions,omitempty,noref"`
Parameters map[string]*Parameter `json:"parameters,omitempty,noref"`
Responses map[string]*Response `json:"responses,omitempty,noref"`
SecurityDefinitions map[string]*SecurityScheme `json:"securityDefinitions,omitempty"`
Security SecurityRequirements `json:"security,omitempty"`
Tags openapi3.Tags `json:"tags,omitempty"`
}
func (swagger *Swagger) AddOperation(path string, method string, operation *Operation) {
paths := swagger.Paths
if paths == nil {
paths = make(map[string]*PathItem, 8)
swagger.Paths = paths
}
pathItem := paths[path]
if pathItem == nil {
pathItem = &PathItem{}
paths[path] = pathItem
}
pathItem.SetOperation(method, operation)
}
type PathItem struct {
Ref string `json:"$ref,omitempty"`
Delete *Operation `json:"delete,omitempty"`
Get *Operation `json:"get,omitempty"`
Head *Operation `json:"head,omitempty"`
Options *Operation `json:"options,omitempty"`
Patch *Operation `json:"patch,omitempty"`
Post *Operation `json:"post,omitempty"`
Put *Operation `json:"put,omitempty"`
Parameters Parameters `json:"parameters,omitempty"`
}
func (pathItem *PathItem) Operations() map[string]*Operation {
operations := make(map[string]*Operation, 8)
if v := pathItem.Delete; v != nil {
operations["DELETE"] = v
}
if v := pathItem.Get; v != nil {
operations["GET"] = v
}
if v := pathItem.Head; v != nil {
operations["HEAD"] = v
}
if v := pathItem.Options; v != nil {
operations["OPTIONS"] = v
}
if v := pathItem.Patch; v != nil {
operations["PATCH"] = v
}
if v := pathItem.Post; v != nil {
operations["POST"] = v
}
if v := pathItem.Put; v != nil {
operations["PUT"] = v
}
return operations
}
func (pathItem *PathItem) GetOperation(method string) *Operation {
switch method {
case "DELETE":
return pathItem.Delete
case "GET":
return pathItem.Get
case "HEAD":
return pathItem.Head
case "OPTIONS":
return pathItem.Options
case "PATCH":
return pathItem.Patch
case "POST":
return pathItem.Post
case "PUT":
return pathItem.Put
default:
panic(fmt.Errorf("Unsupported HTTP method '%s'", method))
}
}
func (pathItem *PathItem) SetOperation(method string, operation *Operation) {
switch method {
case "DELETE":
pathItem.Delete = operation
case "GET":
pathItem.Get = operation
case "HEAD":
pathItem.Head = operation
case "OPTIONS":
pathItem.Options = operation
case "PATCH":
pathItem.Patch = operation
case "POST":
pathItem.Post = operation
case "PUT":
pathItem.Put = operation
default:
panic(fmt.Errorf("Unsupported HTTP method '%s'", method))
}
}
type Operation struct {
Summary string `json:"summary,omitempty"`
Description string `json:"description,omitempty"`
ExternalDocs *openapi3.ExternalDocs `json:"externalDocs,omitempty"`
Tags []string `json:"tags,omitempty"`
OperationID string `json:"operationId,omitempty"`
Parameters Parameters `json:"parameters,omitempty"`
Responses map[string]*Response `json:"responses,omitempty"`
Consumes []string `json:"consumes,omitempty"`
Produces []string `json:"produces,omitempty"`
Security *SecurityRequirements `json:"security,omitempty"`
}
type Parameters []*Parameter
type Parameter struct {
Ref string `json:"$ref,omitempty"`
In string `json:"in,omitempty"`
Name string `json:"name,omitempty"`
Description string `json:"description,omitempty"`
Required bool `json:"required,omitempty"`
UniqueItems bool `json:"uniqueItems,omitempty"`
ExclusiveMin bool `json:"exclusiveMinimum,omitempty"`
ExclusiveMax bool `json:"exclusiveMaximum,omitempty"`
Schema *openapi3.SchemaRef `json:"schema,omitempty"`
Type string `json:"type,omitempty"`
Format string `json:"format,omitempty"`
Enum []interface{} `json:"enum,omitempty"`
Minimum *float64 `json:"minimum,omitempty"`
Maximum *float64 `json:"maximum,omitempty"`
MinLength uint64 `json:"minLength,omitempty"`
MaxLength *uint64 `json:"maxLength,omitempty"`
Pattern string `json:"pattern,omitempty"`
}
type Response struct {
Ref string `json:"$ref,omitempty"`
Description string `json:"description,omitempty"`
Schema *openapi3.SchemaRef `json:"schema,omitempty"`
Headers map[string]*Header `json:"headers,omitempty"`
Examples map[string]interface{} `json:"examples,omitempty"`
}
type Header struct {
Ref string `json:"$ref,omitempty"`
Description string `json:"description,omitempty"`
Type string `json:"type,omitempty"`
}
type SecurityRequirements []map[string][]string
type SecurityScheme struct {
Ref string `json:"$ref,omitempty"`
Description string `json:"description,omitempty"`
Type string `json:"type,omitempty"`
In string `json:"in,omitempty"`
Name string `json:"name,omitempty"`
Flow string `json:"flow,omitempty"`
AuthorizationURL string `json:"authorizationUrl,omitempty"`
TokenURL string `json:"tokenUrl,omitempty"`
Scopes []string `json:"scopes,omitempty"`
Tags openapi3.Tags `json:"tags,omitempty"`
}
|
