lbsadmin/Beego
1
0
Fork 0
mirror of https://github.com/astaxie/beego.git synced 2024-11-26 03:11:30 +00:00
Code Issues Releases Activity

update swagger

Browse Source
This commit is contained in:
astaxie 2016-08-13 14:43:56 +08:00
parent 957db1362f
commit 1b4f30e11e
1 changed files with 29 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
swagger/swagger.go
View File

@ -34,15 +34,15 @@ type Swagger struct {
SecurityDefinitions map[string]Scurity `json:"securityDefinitions,omitempty"` SecurityDefinitions map[string]Scurity `json:"securityDefinitions,omitempty"`
Security map[string][]string `json:"security,omitempty"` Security map[string][]string `json:"security,omitempty"`
Tags []Tag `json:"tags,omitempty"` Tags []Tag `json:"tags,omitempty"`
ExternalDocs ExternalDocs `json:"externalDocs,omitempty"` ExternalDocs *ExternalDocs `json:"externalDocs,omitempty"`
} }
// Information Provides metadata about the API. The metadata can be used by the clients if needed. // Information Provides metadata about the API. The metadata can be used by the clients if needed.
type Information struct { type Information struct {
Title string `json:"title,omitempty"` Title string `json:"title,omitempty"`
Description string `json:"description,omitempty"` Description string `json:"description,omitempty"`
Version string `json:"version,omitempty"` Version string `json:"version,omitempty"`
TermsOfServiceURL string `json:"termsOfServiceUrl,omitempty"` TermsOfService string `json:"termsOfService,omitempty"`
Contact Contact `json:"contact,omitempty"` Contact Contact `json:"contact,omitempty"`
License License `json:"license,omitempty"` License License `json:"license,omitempty"`
@ -89,13 +89,13 @@ type Operation struct {
// Parameter Describes a single operation parameter. // Parameter Describes a single operation parameter.
type Parameter struct { type Parameter struct {
In string `json:"in,omitempty"` In string `json:"in,omitempty"`
Name string `json:"name,omitempty"` Name string `json:"name,omitempty"`
Description string `json:"description,omitempty"` Description string `json:"description,omitempty"`
Required bool `json:"required,omitempty"` Required bool `json:"required,omitempty"`
Schema Schema `json:"schema,omitempty"` Schema *Schema `json:"schema,omitempty"`
Type string `json:"type,omitempty"` Type string `json:"type,omitempty"`
Format string `json:"format,omitempty"` Format string `json:"format,omitempty"`
} }
// Schema Object allows the definition of input and output data types. // Schema Object allows the definition of input and output data types.
@ -111,23 +111,24 @@ type Schema struct {
// Propertie are taken from the JSON Schema definition but their definitions were adjusted to the Swagger Specification // Propertie are taken from the JSON Schema definition but their definitions were adjusted to the Swagger Specification
type Propertie struct { type Propertie struct {
Ref string `json:"$ref,omitempty"` Ref string `json:"$ref,omitempty"`
Title string `json:"title,omitempty"` Title string `json:"title,omitempty"`
Description string `json:"description,omitempty"` Description string `json:"description,omitempty"`
Default string `json:"default,omitempty"` Default string `json:"default,omitempty"`
Type string `json:"type,omitempty"` Type string `json:"type,omitempty"`
Example string `json:"example,omitempty"` Example string `json:"example,omitempty"`
Required []string `json:"required,omitempty"` Required []string `json:"required,omitempty"`
Format string `json:"format,omitempty"` Format string `json:"format,omitempty"`
ReadOnly bool `json:"readOnly,omitempty"` ReadOnly bool `json:"readOnly,omitempty"`
Properties map[string]Propertie `json:"properties,omitempty"` Properties map[string]Propertie `json:"properties,omitempty"`
AdditionalProperties *Propertie `json:"additionalProperties,omitempty"`
} }
// Response as they are returned from executing this operation. // Response as they are returned from executing this operation.
type Response struct { type Response struct {
Description string `json:"description,omitempty"` Description string `json:"description,omitempty"`
Schema Schema `json:"schema,omitempty"` Schema *Schema `json:"schema,omitempty"`
Ref string `json:"$ref,omitempty"` Ref string `json:"$ref,omitempty"`
} }
// Scurity Allows the definition of a security scheme that can be used by the operations // Scurity Allows the definition of a security scheme that can be used by the operations
@ -144,9 +145,9 @@ type Scurity struct {
// Tag Allows adding meta data to a single tag that is used by the Operation Object // Tag Allows adding meta data to a single tag that is used by the Operation Object
type Tag struct { type Tag struct {
Name string `json:"name,omitempty"` Name string `json:"name,omitempty"`
Description string `json:"description,omitempty"` Description string `json:"description,omitempty"`
ExternalDocs ExternalDocs `json:"externalDocs,omitempty"` ExternalDocs *ExternalDocs `json:"externalDocs,omitempty"`
} }
// ExternalDocs include Additional external documentation // ExternalDocs include Additional external documentation