apidocs

type BodyContentStruct struct {
	Description string                 `json:"description"` // The description returned by method.
	Content     map[string]MediaStruct `json:"content,omitempty"`
}

type ComponentStruct struct {
	Schemas map[string]ModelStruct `json:"schemas"`
}

type Definitions struct {
	// contains filtered or unexported fields
}

type InfoStruct struct {
	Title       string `json:"title"`                 // Title of the doc.
	Description string `json:"description,omitempty"` // Description of the doc.
	Version     string `json:"version,omitempty"`     // Version of the doc.
}

type MediaStruct struct {
	Description string `json:"description,omitempty"` // The description returned by method.
	// The reference to the data model for the method reference, must have.
	Schema SchemaStruct `json:"schema,omitempty"`
}

type MethodStruct struct {
	Summary     string                 `json:"summary"`               // Comments of method.
	OperationID string                 `json:"operationId"`           // Name of method.
	Responses   map[string]MediaStruct `json:"responses"`             // Response.
	Parameters  []*ParametersStruct    `json:"parameters"`            // Parameters.
	Tags        []string               `json:"tags"`                  // The service to which the method belongs.
	Description string                 `json:"description,omitempty"` // Description of the method.
}

type MethodStructX struct {
	Summary     string                       `json:"summary,omitempty"`     // Comment of method.
	OperationID string                       `json:"operationId,omitempty"` // Name of method.
	Responses   map[string]BodyContentStruct `json:"responses,omitempty"`   // Response definition of method.

	// Structure  of method's input parameters except body.
	Parameters  []*ParameterStructX `json:"parameters,omitempty"`
	RequestBody *BodyContentStruct  `json:"requestBody,omitempty"` // Struct definition of method input parameters.

	Tags        []string `json:"tags,omitempty"`        // The service to which the method belongs.
	Description string   `json:"description,omitempty"` // Description of the method.
}

type Methods struct {
	Elements map[string]*MethodStruct
	Rank     map[string]int
}

type MethodsX struct {
	Elements map[string]*MethodStructX
	Rank     map[string]int
}

type ModelStruct struct {
	Type                 string          `json:"type"`                           // Data model type
	Properties           *Properties     `json:"properties,omitempty"`           // Data model parameters
	Title                string          `json:"title,omitempty"`                // Data model title
	Description          string          `json:"description,omitempty"`          // Data model description
	AdditionalProperties *PropertyStruct `json:"additionalProperties,omitempty"` // Usage of map value
	Ref                  string          `json:"ref,omitempty"`
	Items                *PropertyStruct `json:"items,omitempty"`
}

type NewPropertyFunc func(field *desc.FieldDescriptor, defs *Definitions) PropertyStruct

type OpenAPIJSON struct {
	OpenAPI string     `json:"openapi"` // Version of OpenAPI.
	Info    InfoStruct `json:"info"`    // Description of the API documentation.

	Paths PathsX `json:"paths"` // Set of specific information for request methods.
	// Definitions of various model data models,
	// including method input and output parameter's structure definitions.
	Components ComponentStruct `json:"components"`
}

type ParameterStructX struct {
	Name string `json:"name"` // Name of the parameter.
	// Parameter's passing method: in, query, path, header, form.
	In          string       `json:"in"`
	Required    bool         `json:"required"`              // Whether the parameter is required or not.
	Description string       `json:"description,omitempty"` // Parameter description.
	Schema      *ModelStruct `json:"schema,omitempty"`      // Parameter reference.
}

type ParametersStruct struct {
	Name string `json:"name"` // Name of the parameter.
	// Parameter's passing method: in, query, path, header, form.
	In          string        `json:"in"`
	Required    bool          `json:"required"`              // Whether the parameter is required or not.
	Type        string        `json:"type,omitempty"`        // Type of parameter.
	Schema      *SchemaStruct `json:"schema,omitempty"`      // Parameter reference, optional.
	Format      string        `json:"format,omitempty"`      // Parameter format, optional.
	Description string        `json:"description,omitempty"` // Parameter description, optional.
	Enum        []int32       `json:"enum,omitempty"`        // Possible values for the enum.
	// When type = array, it is necessary to indicate the member type, that is, the description of a single field value.
	Items   *PropertyStruct `json:"items,omitempty"`
	Default interface{}     `json:"default,omitempty"` // Default value of the parameter.
}

type Paths struct {
	Elements map[string]Methods
	Rank     map[string]int
}

type PathsX struct {
	Elements map[string]MethodsX
	Rank     map[string]int
}

type Properties struct {
	Elements map[string]PropertyStruct
	Rank     map[string]int
}

type PropertyStruct struct {
	Title       string  `json:"title,omitempty"`       // Name of parameter.
	Type        string  `json:"type,omitempty"`        // Type of parameter.
	Format      string  `json:"format,omitempty"`      // Format of parameter.
	Ref         string  `json:"$ref,omitempty"`        // References in parameter.
	Description string  `json:"description,omitempty"` // Description of paramaeter.
	Enum        []int32 `json:"enum,omitempty"`        // Possible values of the enum type.
	// When type is array, specify the member type, i.e., the description of a single field value.
	Items *PropertyStruct `json:"items,omitempty"`
}

type SchemaStruct struct {
	Ref        string            `json:"$ref,omitempty"`
	Type       string            `json:"type,omitempty"`
	Properties []*PropertyStruct `json:"properties,omitempty"`
}

type SwaggerJSON struct {
	Swagger string     `json:"swagger"` // Version of Swagger.
	Info    InfoStruct `json:"info"`    // Description information of the API document.

	Consumes []string `json:"consumes"`
	Produces []string `json:"produces"`

	// A collection of detailed information for the request method.
	Paths Paths `json:"paths"`
	// Various model definitions, including the structure definitions of method input and output parameters.
	Definitions map[string]ModelStruct `json:"definitions"`
}