swagger

package

v0.0.0-...-0f6a4a1 Latest Latest Go to latest Published: Mar 3, 2019 License: MIT Imports: 0 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/spatialcurrent/go-swagger-structs

Links

Open Source Insights

Documentation ¶

Overview ¶

=================================================================

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Contact ¶

type Contact struct {
	Name  string `json:"name,omitempty" yaml:"name,omitempty"`
	Email string `json:"email,omitempty" yaml:"email,omitempty"`
	Url   string `json:"url,omitempty" yaml:"url,omitempty"`
}

type Definition ¶

type Definition struct {
	Type       string              `json:"type" yaml:"type"`
	Required   []string            `json:"required,omitempty" yaml:"required,omitempty"`
	Properties map[string]Property `json:"properties,omitempty" yaml:"properties,omitempty"`
}

type Document ¶

type Document struct {
	Version     string                `json:"swagger" yaml:"swagger"`
	Schemes     []string              `json:"schemes" yaml:"schemes"`
	BasePath    string                `json:"basePath" yaml:"basePath"`
	Host        string                `json:"host" yaml:"host"`
	External    *External             `json:"externalDocs,omitempty" yaml:"externalDocs,omitempty"`
	Info        *Info                 `json:"info,omitempty" yaml:"info,omitempty"`
	Paths       map[string]Path       `json:"paths" yaml:"paths"`
	Definitions map[string]Definition `json:"definitions,omitempty" yaml:"definitions,omitempty"`
}

type External ¶

type External struct {
	Description string `json:"description" yaml:"description"`
	Url         string `json:"url" yaml:"url"`
}

type Info ¶

type Info struct {
	Version        string   `json:"version" yaml:"version"`
	Title          string   `json:"title" yaml:"title"`
	Description    string   `json:"description" yaml:"description"`
	TermsOfService string   `json:"termsOfService" yaml:"termsOfService"`
	Contact        *Contact `json:"contact,omitempty" yaml:"contact,omitempty"`
	License        *License `json:"license,omitempty" yaml:"license,omitempty"`
}

type License ¶

type License struct {
	Name string `json:"name" yaml:"name"`
	Url  string `json:"url" yaml:"url"`
}

type Operation ¶

type Operation struct {
	Tags        []string            `json:"tags" yaml:"tags"`
	Summary     string              `json:"summary,omitempty" yaml:"summary,omitempty"`
	Description string              `json:"description,omitempty" yaml:"description,omitempty"`
	Consumes    []string            `json:"consumes,omitempty" yaml:"consumes,omitempty"`
	Produces    []string            `json:"produces,omitempty" yaml:"produces,omitempty"`
	Parameters  []Parameter         `json:"parameters,omitempty" yaml:"parameters,omitempty"`
	Responses   map[string]Response `json:"responses" yaml:"responses"`
}

type Parameter ¶

type Parameter struct {
	Name        string      `json:"name" yaml:"name"`
	Required    bool        `json:"required" bson:"required"`
	Type        string      `json:"type,omitempty" yaml:"type,omitempty"`
	In          string      `json:"in" yaml:"in"`
	Description string      `json:"description,omitempty" yaml:"description,omitempty"`
	Default     interface{} `json:"default,omitempty" yaml:"default,omitempty"`
	Minimum     *int        `json:"minimum,omitempty" yaml:"minimum,omitempty"`
	Maximum     *int        `json:"maximum,omitempty" yaml:"maximum,omitempty"`
	Enumeration []string    `json:"enum,omitempty" yaml:"enum,omitempty"`
	Schema      *Schema     `json:"schema,omitempty" yaml:"schema,omitempty"`
}

type Path ¶

type Path struct {
	Summary     string    `json:"summary,omitempty" yaml:"summary,omitempty"`
	Description string    `json:"description,omitempty" yaml:"description,omitempty"`
	Get         Operation `json:"get,omitempty" yaml:"get,omitempty"`
	Post        Operation `json:"post,omitempty" yaml:"post,omitempty"`
	Delete      Operation `json:"delete,omitempty" yaml:"delete,omitempty"`
}

type Property ¶

type Property struct {
	Type string `json:"type" yaml:"type"`
}

type Response ¶

type Response struct {
	Description string `json:"description,omitempty" yaml:"description,omitempty"`
}

type Schema ¶

type Schema struct {
	Ref string `json:"$ref,omitempty" yaml:"$ref,omitempty"`
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL