docs

package

Go to main page

Versions in this module

v0

v0.10.2

Sep 11, 2023

v0.10.1

May 17, 2023

v0.10.0

May 17, 2023

Changes in this version

type Options

+ Components *openapi3.Components

+ Security openapi3.SecurityRequirements

v0.9.0

May 9, 2023

v0.8.0

Apr 28, 2023

v0.7.0

Dec 5, 2022

Changes in this version

type Endpoint

+ func (e *Endpoint) AddErrorResponse(responseType reflect.Type)

+ func (e *Endpoint) AddResponse(responseType reflect.Type)

v0.6.0

May 1, 2022

v0.5.0

Feb 23, 2022

Changes in this version

+ const NoUrl

type Docs

+ InteractiveUrl string

+ JsonUrl string

+ OpenApi *openapi3.T

+ YamlUrl string

+ func New(options *Options) *Docs

+ func (d *Docs) NormalizePath(path string) string

+ func (d *Docs) RegisterRoutes(router gin.IRouter, port string)

+ func (d *Docs) SaveAsJson(path string) error

+ func (d *Docs) SaveAsYaml(path string) error

type Handler

+ func (h *Handler) JsonFile(ctx *gin.Context)

+ func (h *Handler) YamlFile(ctx *gin.Context)

+ type Options struct

+ Contact *openapi3.Contact

+ Description string

+ ExtensionProps openapi3.ExtensionProps

+ InteractiveUrl string

+ JsonUrl string

+ License *openapi3.License

+ Servers []string

+ Tags []string

+ TermsOfService string

+ Title string

+ Version string

+ YamlUrl string

v0.4.0

Feb 22, 2022

Changes in this version

+ const BindingTag

+ const DefaultStatusTag

+ const DefaultTag

+ const HeaderTag

+ const JsonTag

+ const StatusCodesTag

type Docs

+ func (d *Docs) SetPath(path string, method string, doc *Endpoint)

+ type Endpoint openapi3.Operation

+ func (e *Endpoint) AddHeadersType(headerType reflect.Type)

+ func (e *Endpoint) AddPathParam(name string, type_ reflect.Type)

+ func (e *Endpoint) SetBodyType(bodyType reflect.Type)

+ func (e *Endpoint) SetQueryType(queryType reflect.Type)

+ func (e *Endpoint) SetResponses(responseType reflect.Type, errorType reflect.Type)

+ func (e *Endpoint) SetTagsFromPath(path string)

v0.3.0

Feb 6, 2022

Changes in this version

type Docs

+ func (d *Docs) ParseHeaderParams(headerModel interface{}) openapi3.Parameters

v0.2.0

Jan 31, 2022

Changes in this version

+ const StatusCodes

v0.1.0

Jan 15, 2022

Changes in this version

+ const Binding

+ const Default

+ const DefaultStatus

+ const Errors

+ const Json

+ type Docs struct

+ CORS *cors.Config

+ Contact *openapi3.Contact

+ Description string

+ InMemory bool

+ License *openapi3.License

+ OpenAPI *openapi3.T

+ OpenAPIFilePath string

+ OpenAPIPath string

+ OpenAPIUrl string

+ TermsOfService string

+ Title string

+ Version string

+ func (d *Docs) AddParamToOperation(paramName string, paramType reflect.Type, operation *openapi3.Operation)

+ func (d *Docs) AddParametersToOperation(params openapi3.Parameters, operation *openapi3.Operation)

+ func (d *Docs) AddServer(addr string)

+ func (d *Docs) Build() error

+ func (d *Docs) CORSConfig() *cors.Config

+ func (d *Docs) ConvertModelToRequestBody(model interface{}, contentType string) *openapi3.RequestBodyRef

+ func (d *Docs) ConvertTypeToInterface(t reflect.Type) interface{}

+ func (d *Docs) CreateResponses(model interface{}, errorModel interface{}) openapi3.Responses

+ func (d *Docs) FixPath(path string) string

+ func (d *Docs) NewOpenAPI()

+ func (d *Docs) OpenAPIContent() *openapi3.T

+ func (d *Docs) ParseQueryParams(queryModel interface{}) openapi3.Parameters

+ func (d *Docs) PathItem(path string) *openapi3.PathItem

+ func (d *Docs) PathTags(path string) []string

+ func (d *Docs) PathsIsEmpty() bool

+ func (d *Docs) ResponseDefaultStatus(model interface{}) int

+ func (d *Docs) SetOperationOnPath(path string, method string, operation openapi3.Operation)

+ func (d *Docs) SetPathItem(path string, pathItem *openapi3.PathItem)

+ func (d *Docs) Valid() error

+ type Handler struct

+ func NewHandler(docs *Docs) *Handler

+ func (h *Handler) Docs(ctx *gin.Context)

+ func (h *Handler) File(ctx *gin.Context)

+ type PathDoc openapi3.Operation

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