Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

clearspec

package module

Go to main page

Versions in this module

v1

v1.0.0

Jun 11, 2025

v0

v0.0.1

Jun 11, 2025

Changes in this version

+ func GetSwaggerTag(field reflect.StructField) map[string]string

+ type Generator struct

+ func NewGenerator(info SwaggerInfo) *Generator

+ func (g *Generator) AddSecurityDefinition(name string, definition interface{})

+ func (g *Generator) GenerateSwagger() *Swagger

+ func (g *Generator) GetSwagger() *Swagger

+ func (g *Generator) RegisterRoute(method, path string, handler interface{}, options ...RouteOption)

+ func (g *Generator) SetBasePath(basePath string)

+ func (g *Generator) SetHost(host string)

+ func (g *Generator) SetSchemes(schemes []string)

+ func (g *Generator) SetupFiberSwagger(app *fiber.App, path string)

+ func (g *Generator) SetupFiberSwaggerYAML(app *fiber.App, path string)

+ func (g *Generator) SetupSwaggerUI(app *fiber.App, swaggerPath, uiPath string)

+ func (g *Generator) ToJSON() ([]byte, error)

+ func (g *Generator) ToYAML() ([]byte, error)

+ type HandlerAnnotation struct

+ Description string

+ Security []string

+ Summary string

+ Tags []string

+ type Header struct

+ Description string

+ Format string

+ Type string

+ type Items struct

+ Format string

+ Type string

+ type MiddlewareConfig struct

+ BasePath string

+ Path string

+ Title string

+ type Operation struct

+ Consumes []string

+ Deprecated bool

+ Description string

+ OperationID string

+ Parameters []Parameter

+ Produces []string

+ Responses map[string]Response

+ Security []map[string][]string

+ Summary string

+ Tags []string

+ type Parameter struct

+ CollectionFormat string

+ Description string

+ Enum []string

+ Format string

+ In string

+ Items *Items

+ Maximum *float64

+ Minimum *float64

+ Name string

+ Required bool

+ Schema *Schema

+ Type string

+ type Response struct

+ Description string

+ Headers map[string]Header

+ Schema *Schema

+ type ResponseInfo struct

+ Description string

+ Headers map[string]string

+ StatusCode int

+ Type reflect.Type

+ type RouteInfo struct

+ Consumes []string

+ Deprecated bool

+ Description string

+ Handler interface{}

+ Method string

+ Path string

+ Produces []string

+ RequestType reflect.Type

+ ResponseType reflect.Type

+ Responses []ResponseInfo

+ Security map[string][]string

+ Summary string

+ Tags []string

+ type RouteOption func(*RouteInfo)

+ func WithBadRequestResponse(errorType interface{}, description string) RouteOption

+ func WithConsumes(consumes []string) RouteOption

+ func WithCreatedResponse(responseType interface{}, description string) RouteOption

+ func WithDeprecated(deprecated bool) RouteOption

+ func WithDescription(description string) RouteOption

+ func WithErrorResponse(statusCode int, errorType interface{}, description string) RouteOption

+ func WithForbiddenResponse(errorType interface{}, description string) RouteOption

+ func WithInternalServerErrorResponse(errorType interface{}, description string) RouteOption

+ func WithNoContentResponse(description string) RouteOption

+ func WithNotFoundResponse(errorType interface{}, description string) RouteOption

+ func WithProduces(produces []string) RouteOption

+ func WithRequestType(t interface{}) RouteOption

+ func WithResponse(statusCode int, responseType interface{}, description string) RouteOption

+ func WithResponseHeaders(headers map[string]string) RouteOption

+ func WithResponseType(t interface{}) RouteOption

+ func WithSecurity(security map[string][]string) RouteOption

+ func WithSuccessResponse(responseType interface{}, description string) RouteOption

+ func WithSummary(summary string) RouteOption

+ func WithTags(tags ...string) RouteOption

+ func WithUnauthorizedResponse(errorType interface{}, description string) RouteOption

+ type Schema struct

+ AdditionalProperties *Schema

+ Description string

+ Enum []interface{}

+ Example interface{}

+ Format string

+ Items *Schema

+ Properties map[string]*Schema

+ Ref string

+ Required []string

+ Type string

+ func GetTypeSwagger(t reflect.Type) *Schema

+ type SecurityDefinition struct

+ BearerFormat string

+ In string

+ Name string

+ Scheme string

+ Type string

+ type Swagger struct

+ BasePath string

+ Consumes []string

+ Definitions map[string]*Schema

+ Host string

+ Info SwaggerInfo

+ Paths map[string]map[string]Operation

+ Produces []string

+ Schemes []string

+ Security []map[string][]string

+ SecurityDefinitions map[string]SecurityDefinition

+ Swagger string

+ type SwaggerInfo struct

+ BasePath string

+ Description string

+ Host string

+ Title string

+ Version string

+ type SwaggerMiddleware struct

+ func NewMiddleware(info SwaggerInfo, config MiddlewareConfig) *SwaggerMiddleware

+ func (m *SwaggerMiddleware) GetSwagger() *Swagger

+ func (m *SwaggerMiddleware) Handler() fiber.Handler

+ func (m *SwaggerMiddleware) Route(method, path string, handler fiber.Handler, options ...RouteOption) fiber.Handler

+ func (m *SwaggerMiddleware) ToJSON() ([]byte, error)