builder

Documentation

Index

• type API
• type Array
• type ExternalDocs
• type FormProperties
  • func NewFormProperties(name string, typ reflect.Type) FormProperties
• type Info
• type ModelSchema
  • func NewObjectModelSchema(typ reflect.Type) ModelSchema
• type Object
  • func BuildOpenAPI(info Info, docs ExternalDocs, servers []string, tags []Tag, api []API, ...) Object
• type Parameter
  • func NewParameter(name string, in string, description string, required bool, typ reflect.Type) Parameter
• type Properties
• type RequestBody
• type Response
• type Schema
  • func NewArraySchema(typ reflect.Type) Schema
  • func NewFormSchema(properties []FormProperties) Schema
  • func NewJsonSchema(typ reflect.Type) Schema
  • func NewMultipartSchema(name string) Schema
  • func NewObjectSchema(typ reflect.Type) Schema
  • func NewStreamSchema() Schema
• type Tag

Types

type API

type API struct {
	URL                     string
	Method                  string
	Tags                    []string
	Summary                 string
	Description             string
	OperationId             string
	RequestBody             RequestBody
	Parameters              []Parameter
	Responses               []Response
	XCodegenRequestBodyName string
}

type Array

type Array []Object

type ExternalDocs

type ExternalDocs struct {
	Description string
	Url         string
}

type FormProperties

type FormProperties struct {
	Name        string
	Type        string
	Description string
}

func NewFormProperties

func NewFormProperties(name string, typ reflect.Type) FormProperties

type Info

type Info struct {
	Title          string
	Description    string
	TermsOfService string
	Email          string
	LicenseName    string
	LicenseUrl     string
	Version        string
}

type ModelSchema

type ModelSchema struct {
	Model           string
	Type            string
	FieldProperties []Properties
}

func NewObjectModelSchema

func NewObjectModelSchema(typ reflect.Type) ModelSchema

type Object

type Object map[string]interface{}

func BuildOpenAPI

func BuildOpenAPI(info Info, docs ExternalDocs, servers []string, tags []Tag, api []API, models []ModelSchema) Object

type Parameter

type Parameter struct {
	Name        string
	In          string
	Description string
	Required    bool
	Schema      Schema
}

func NewParameter

func NewParameter(name string, in string, description string, required bool, typ reflect.Type) Parameter

type Properties

type Properties struct {
	Name   string
	Schema Schema
}

type RequestBody

type RequestBody struct {
	Description string
	Contents    []Schema
	Required    bool
}

type Response

type Response struct {
	HttpStatusCode string
	Description    string
	Contents       []Schema
}

type Schema

type Schema struct {
	Ref            string
	ContentType    string
	Type           string
	Format         string
	FormProperties []FormProperties
}

func NewArraySchema

func NewArraySchema(typ reflect.Type) Schema

func NewFormSchema

func NewFormSchema(properties []FormProperties) Schema

func NewJsonSchema

func NewJsonSchema(typ reflect.Type) Schema

func NewMultipartSchema

func NewMultipartSchema(name string) Schema

func NewObjectSchema

func NewObjectSchema(typ reflect.Type) Schema

func NewStreamSchema

func NewStreamSchema() Schema

type Tag

type Tag struct {
	Name         string
	Description  string
	ExternalDocs ExternalDocs
}