Documentation
¶
Index ¶
- Constants
- func AddPredefinedController(builder *DocumentBuilder, ctrl *server.PredefinedController, ...)
- func AddResourceController(builder *DocumentBuilder, ctrl *server.ResourceController, ...)
- func GetPatchBodySchema(patches []store.Patch) []byte
- type Components
- type Document
- type DocumentBuilder
- func (b *DocumentBuilder) AddNewPath(path string) *PathItemBuilder
- func (b *DocumentBuilder) AddPath(path string, pathItem *PathItem) *DocumentBuilder
- func (b *DocumentBuilder) AddResponse(statusCode string, schemaItem SchemaItem) *DocumentBuilder
- func (b *DocumentBuilder) AddSchemaBytes(name string, schemaBytes []byte) (*DocumentBuilder, error)
- func (b *DocumentBuilder) AddSchemaBytesOrDie(name string, schemaBytes []byte) *DocumentBuilder
- func (b *DocumentBuilder) AddSchemaItem(name string, schemaItem SchemaItem) *DocumentBuilder
- func (b *DocumentBuilder) AddServer(url, description string) *DocumentBuilder
- func (b *DocumentBuilder) Build() *Document
- func (b *DocumentBuilder) BuildBytes() ([]byte, error)
- func (b *DocumentBuilder) NewInfo(title, description, version string) *DocumentBuilder
- func (b *DocumentBuilder) SetOpenapiVersion(version string) *DocumentBuilder
- type Info
- type MediaType
- type OpenAPIController
- type Operation
- type OperationBuilder
- func (b *OperationBuilder) AddParameter(parameter *Parameter) *OperationBuilder
- func (b *OperationBuilder) AddTags(tags ...string) *OperationBuilder
- func (b *OperationBuilder) Build() *Operation
- func (b *OperationBuilder) SetCustomRequestBody(contentType string, SchemaItem SchemaItem) *OperationBuilder
- func (b *OperationBuilder) SetCustomResponse(statusCode, contentType string, SchemaItem SchemaItem) *OperationBuilder
- func (b *OperationBuilder) SetDescription(description string) *OperationBuilder
- func (b *OperationBuilder) SetJsonRequestBody(SchemaItem SchemaItem) *OperationBuilder
- func (b *OperationBuilder) SetJsonRequestBodyBytes(SchemaItemBytes []byte) *OperationBuilder
- func (b *OperationBuilder) SetJsonResponse(statusCode string, SchemaItem SchemaItem) *OperationBuilder
- func (b *OperationBuilder) SetJsonResponseBytes(statusCode string, SchemaItemBytes []byte) *OperationBuilder
- func (b *OperationBuilder) SetMeta(summary, operationId string) *OperationBuilder
- type Parameter
- type ParameterBuilder
- func (b *ParameterBuilder) Build() *Parameter
- func (b *ParameterBuilder) SetDescription(description string) *ParameterBuilder
- func (b *ParameterBuilder) SetIn(in string) *ParameterBuilder
- func (b *ParameterBuilder) SetName(name string) *ParameterBuilder
- func (b *ParameterBuilder) SetRequired(required bool) *ParameterBuilder
- func (b *ParameterBuilder) SetSchema(SchemaItem SchemaItem) *ParameterBuilder
- type PathItem
- type PathItemBuilder
- type RequestBody
- type Response
- type Responses
- type SchemaItem
- type Server
- type Tag
Constants ¶
View Source
const (
ApiProblemSchema = `` /* 587-byte string literal not displayed */
)
Variables ¶
This section is empty.
Functions ¶
func AddPredefinedController ¶
func AddPredefinedController(builder *DocumentBuilder, ctrl *server.PredefinedController, opts server.ControllerOpts)
func AddResourceController ¶
func AddResourceController(builder *DocumentBuilder, ctrl *server.ResourceController, opts server.ControllerOpts)
func GetPatchBodySchema ¶
Types ¶
type Components ¶
type Components struct {
Responses map[string]SchemaItem `json:"responses,omitempty"`
Schemas map[string]SchemaItem `json:"schemas,omitempty"`
}
type Document ¶
type Document struct {
Openapi string `json:"openapi"`
Info *Info `json:"info,omitempty"`
Tags []Tag `json:"tags,omitempty"`
Servers []Server `json:"servers,omitempty"`
Paths map[string]*PathItem `json:"paths,omitempty"`
Components *Components `json:"components,omitempty"`
}
func NewDocument ¶
func NewDocument() *Document
type DocumentBuilder ¶
type DocumentBuilder struct {
// contains filtered or unexported fields
}
func NewDocumentBuilder ¶
func NewDocumentBuilder() *DocumentBuilder
func (*DocumentBuilder) AddNewPath ¶
func (b *DocumentBuilder) AddNewPath(path string) *PathItemBuilder
func (*DocumentBuilder) AddPath ¶
func (b *DocumentBuilder) AddPath(path string, pathItem *PathItem) *DocumentBuilder
func (*DocumentBuilder) AddResponse ¶
func (b *DocumentBuilder) AddResponse(statusCode string, schemaItem SchemaItem) *DocumentBuilder
func (*DocumentBuilder) AddSchemaBytes ¶
func (b *DocumentBuilder) AddSchemaBytes(name string, schemaBytes []byte) (*DocumentBuilder, error)
func (*DocumentBuilder) AddSchemaBytesOrDie ¶
func (b *DocumentBuilder) AddSchemaBytesOrDie(name string, schemaBytes []byte) *DocumentBuilder
func (*DocumentBuilder) AddSchemaItem ¶
func (b *DocumentBuilder) AddSchemaItem(name string, schemaItem SchemaItem) *DocumentBuilder
func (*DocumentBuilder) AddServer ¶
func (b *DocumentBuilder) AddServer(url, description string) *DocumentBuilder
func (*DocumentBuilder) Build ¶
func (b *DocumentBuilder) Build() *Document
func (*DocumentBuilder) BuildBytes ¶
func (b *DocumentBuilder) BuildBytes() ([]byte, error)
func (*DocumentBuilder) NewInfo ¶
func (b *DocumentBuilder) NewInfo(title, description, version string) *DocumentBuilder
func (*DocumentBuilder) SetOpenapiVersion ¶
func (b *DocumentBuilder) SetOpenapiVersion(version string) *DocumentBuilder
type MediaType ¶
type MediaType struct {
Schema *SchemaItem `json:"schema"`
}
type OpenAPIController ¶
type OpenAPIController struct {
Document *Document
}
func NewOpenAPIController ¶
func NewOpenAPIController(doc *Document) *OpenAPIController
func (*OpenAPIController) GetOpenAPI ¶
func (r *OpenAPIController) GetOpenAPI(c *fiber.Ctx) error
func (*OpenAPIController) Register ¶
func (r *OpenAPIController) Register(router fiber.Router, opts server.ControllerOpts)
type Operation ¶
type Operation struct {
Tags []string `json:"tags,omitempty"`
Summary string `json:"summary"`
OperationId string `json:"operationId"`
Description string `json:"description,omitempty"`
Parameters []*Parameter `json:"parameters,omitempty"`
RequestBody *RequestBody `json:"requestBody,omitempty"`
Responses map[string]*Response `json:"responses,omitempty"`
}
type OperationBuilder ¶
type OperationBuilder struct {
// contains filtered or unexported fields
}
func NewOperationBuilder ¶
func NewOperationBuilder() *OperationBuilder
func (*OperationBuilder) AddParameter ¶
func (b *OperationBuilder) AddParameter(parameter *Parameter) *OperationBuilder
func (*OperationBuilder) AddTags ¶
func (b *OperationBuilder) AddTags(tags ...string) *OperationBuilder
func (*OperationBuilder) Build ¶
func (b *OperationBuilder) Build() *Operation
func (*OperationBuilder) SetCustomRequestBody ¶
func (b *OperationBuilder) SetCustomRequestBody(contentType string, SchemaItem SchemaItem) *OperationBuilder
func (*OperationBuilder) SetCustomResponse ¶
func (b *OperationBuilder) SetCustomResponse(statusCode, contentType string, SchemaItem SchemaItem) *OperationBuilder
func (*OperationBuilder) SetDescription ¶
func (b *OperationBuilder) SetDescription(description string) *OperationBuilder
func (*OperationBuilder) SetJsonRequestBody ¶
func (b *OperationBuilder) SetJsonRequestBody(SchemaItem SchemaItem) *OperationBuilder
func (*OperationBuilder) SetJsonRequestBodyBytes ¶
func (b *OperationBuilder) SetJsonRequestBodyBytes(SchemaItemBytes []byte) *OperationBuilder
func (*OperationBuilder) SetJsonResponse ¶
func (b *OperationBuilder) SetJsonResponse(statusCode string, SchemaItem SchemaItem) *OperationBuilder
func (*OperationBuilder) SetJsonResponseBytes ¶
func (b *OperationBuilder) SetJsonResponseBytes(statusCode string, SchemaItemBytes []byte) *OperationBuilder
func (*OperationBuilder) SetMeta ¶
func (b *OperationBuilder) SetMeta(summary, operationId string) *OperationBuilder
type Parameter ¶
type Parameter struct {
Name string `json:"name"`
In string `json:"in"`
Description string `json:"description"`
Required bool `json:"required"`
Schema *SchemaItem `json:"schema"`
}
func GetFilterParameters ¶
type ParameterBuilder ¶
type ParameterBuilder struct {
// contains filtered or unexported fields
}
func NewParameterBuilder ¶
func NewParameterBuilder() *ParameterBuilder
func (*ParameterBuilder) Build ¶
func (b *ParameterBuilder) Build() *Parameter
func (*ParameterBuilder) SetDescription ¶
func (b *ParameterBuilder) SetDescription(description string) *ParameterBuilder
func (*ParameterBuilder) SetIn ¶
func (b *ParameterBuilder) SetIn(in string) *ParameterBuilder
func (*ParameterBuilder) SetName ¶
func (b *ParameterBuilder) SetName(name string) *ParameterBuilder
func (*ParameterBuilder) SetRequired ¶
func (b *ParameterBuilder) SetRequired(required bool) *ParameterBuilder
func (*ParameterBuilder) SetSchema ¶
func (b *ParameterBuilder) SetSchema(SchemaItem SchemaItem) *ParameterBuilder
type PathItemBuilder ¶
type PathItemBuilder struct {
// contains filtered or unexported fields
}
func NewPathItemBuilder ¶
func NewPathItemBuilder() *PathItemBuilder
func (*PathItemBuilder) Build ¶
func (b *PathItemBuilder) Build() *PathItem
func (*PathItemBuilder) SetOperation ¶
func (b *PathItemBuilder) SetOperation(method string, operation *Operation) *PathItemBuilder
type RequestBody ¶
type SchemaItem ¶
func NewArrayOfSchemaItemWithRef ¶
func NewArrayOfSchemaItemWithRef(ref SchemaItem) SchemaItem
func NewSchemaItemResponseRef ¶
func NewSchemaItemResponseRef(statusCode string) (string, SchemaItem)
func NewSchemaItemSchemaRef ¶
func NewSchemaItemSchemaRef(name string) SchemaItem
func NewSchemaItemType ¶
func NewSchemaItemType(schemaType string) SchemaItem
func (SchemaItem) AddAttribute ¶
func (s SchemaItem) AddAttribute(name string, value any) SchemaItem
Click to show internal directories.
Click to hide internal directories.