models

Documentation

Index

• type Config
• type Parameter
• type RateLimitConfig
• type RequestBody
• type Response
• type RouteInfo

Types

type Config

type Config struct {
	RateLimit RateLimitConfig
}

Config contém configurações gerais da aplicação

type Parameter

type Parameter struct {
	Name        string
	Type        string
	Description string
	Required    bool
}

Parameter representa um parâmetro da rota

type RateLimitConfig

type RateLimitConfig struct {
	RequestsPerMinute int
	TimeWindowSeconds int
}

RateLimitConfig contém configurações de rate limiting

type RequestBody

type RequestBody struct {
	Type   string
	Schema interface{}
}

RequestBody representa o corpo da requisição

type Response

type Response struct {
	StatusCode  int
	Type        string
	Description string
	Schema      interface{}
}

Response representa uma resposta da API

type RouteInfo

type RouteInfo struct {
	Path        string
	Method      string
	HandlerName string
	Version     string
	Description string
	Parameters  []Parameter
	QueryParams []Parameter
	Request     RequestBody
	Responses   []Response
}

RouteInfo contém informações sobre uma rota da API