Documentation
¶
Index ¶
Constants ¶
View Source
const ( HealthEndpoint = "/healthz" ReadyEndpoint = "/readyz" SwaggerEndpoint = "/swagger/*any" ApiV1BasePath = "/api/v1" MetricsEndpoint = "/metrics" InfoEndpoint = "/info" RabbitMQEndpoint = "api/queues/%2F/" DefaultUser = "guest" DefaultPassword = "guest" )
Constants for common endpoint paths
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Api ¶
type Api struct {
MgtUrl string
QueueName string
Port int
UserName string
Password string
// contains filtered or unexported fields
}
Api provides server configuration details and handlers
func (*Api) Info ¶
Info godoc @BasePath /api/v1 @Summary Info @Description provides server info @Tags example @Produce json @Success 200 {object} Info @Router /info [get]
type ApiConf ¶
type ApiConf struct {
MgtUrl string `yaml:"MgtUrl"`
Port int `yaml:"Port"`
CompileDate string
Version string
LogLevel int `yaml:"LogLevel"`
QueueName string `yaml:"QueueName"`
UserName string `yaml:"UserName"`
Password string `yaml:"Password"`
}
ApiConf Define configuration for the API, using yaml tagged fields for configuration parsing
Click to show internal directories.
Click to hide internal directories.