goapi

type ConfigOperation ¶

type ConfigOperation func(op *Operation)

func Description(d string) ConfigOperation

func OperationID(id string) ConfigOperation

func Summary(s string) ConfigOperation

func Tags(tags ...string) ConfigOperation

type Descriptioner ¶ added in v0.3.0

type Descriptioner interface {
	Description() string
}

type Error ¶

type Error struct {
	// Code is a machine-readable error code.
	Code string `json:"code,omitempty"`
	// Message is a human-readable error message.
	Message string `json:"message,omitempty"`
	// Target is a human-readable description of the target of the error.
	Target string `json:"target,omitempty"`
	// Details is an array of structured error details objects.
	Details []Error `json:"details,omitempty"`
	// InnerError is a generic error object that is used by the service developer for debugging.
	InnerError any `json:"innererror,omitempty"`
}

Error is an error object that contains information about a failed request. Reference: https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#error--object

type Group ¶

type Group struct {
	// contains filtered or unexported fields
}

func New() *Group

NewRouter().Group("")

func (g *Group) Add(
	method openapi.Method, path string, handler any, opts ...ConfigOperation,
)

func (g *Group) DELETE(path string, handler any, opts ...ConfigOperation)

func (g *Group) GET(path string, handler any, opts ...ConfigOperation)

func (g *Group) Group(prefix string) *Group

func (g *Group) HEAD(path string, handler any, opts ...ConfigOperation)

func (g *Group) Handler(h http.Handler) http.Handler

func (g *Group) OPTIONS(path string, handler any, opts ...ConfigOperation)

func (r *Group) OpenAPI(schemas *jschema.Schemas) *openapi.Document

func (g *Group) PATCH(path string, handler any, opts ...ConfigOperation)

func (g *Group) POST(path string, handler any, opts ...ConfigOperation)

func (g *Group) PUT(path string, handler any, opts ...ConfigOperation)

func (g *Group) Server() http.Handler

func (g *Group) Shutdown(ctx context.Context) error

func (g *Group) Start(addr string) error

func (g *Group) Use(m Middleware)

type InBody ¶

type InBody struct{}

type InHeader ¶

type InHeader struct{}

type InURL ¶

type InURL struct{}

type Middleware ¶

type Middleware interface {
	// A Middleware https://cs.opensource.google/go/x/pkgsite/+/68be0dd1:internal/middleware/middleware.go
	Handler(next http.Handler) http.Handler
}

type MiddlewareFunc ¶

type MiddlewareFunc func(next http.Handler) http.Handler

func (fn MiddlewareFunc) Handler(next http.Handler) http.Handler

type Operation ¶

type Operation struct {
	// contains filtered or unexported fields
}

Operation is a handler for a specific HTTP method and path. We use reflection to constrain the handler function signature, to make it follow the openapi spec.

func (op *Operation) Handler(next http.Handler) http.Handler

type OperationMeta ¶

type OperationMeta struct {
	// Summary is used for display in the openapi UI.
	Summary string
	// Description is used for display in the openapi UI.
	Description string
	// OperationID is a unique string used to identify an individual operation.
	// This can be used by tools and libraries to provide functionality for
	// referencing and calling the operation from different parts of your application.
	OperationID string
	// Tags are used for grouping operations together for display in the openapi UI.
	Tags []string
}

type Params ¶

type Params interface {
	// contains filtered or unexported methods
}

type Path ¶

type Path struct {
	// contains filtered or unexported fields
}

Path helps to handle openapi path pattern.

type Response ¶

type Response interface {
	// contains filtered or unexported methods
}

Response is an interface that represents a response object.

type Router ¶

type Router struct {
	Server *http.Server
	// contains filtered or unexported fields
}

Router itself is a middleware.

func NewRouter() *Router

func (r *Router) Group(prefix string) *Group

func (r *Router) Handler(next http.Handler) http.Handler

func (r *Router) OpenAPI(schemas *jschema.Schemas) *openapi.Document

func (r *Router) ServerHandler() http.Handler

func (r *Router) Shutdown(ctx context.Context) error

func (r *Router) Start(addr string) error

func (r *Router) Use(middlewares ...Middleware)

type StatusAccepted ¶

type StatusAccepted struct{}

StatusAccepted 202.

type StatusAlreadyReported ¶

type StatusAlreadyReported struct{}

StatusAlreadyReported 208.

type StatusBadGateway ¶

type StatusBadGateway struct{}

StatusBadGateway 502.

type StatusBadRequest ¶

type StatusBadRequest struct{}

StatusBadRequest 400.

type StatusConflict ¶

type StatusConflict struct{}

StatusConflict 409.

type StatusContinue ¶

type StatusContinue struct{}

StatusContinue 100.

type StatusCreated ¶

type StatusCreated struct{}

StatusCreated 201.

type StatusEarlyHints ¶

type StatusEarlyHints struct{}

StatusEarlyHints 103.

type StatusExpectationFailed ¶

type StatusExpectationFailed struct{}

StatusExpectationFailed 417.

type StatusFailedDependency ¶

type StatusFailedDependency struct{}

StatusFailedDependency 424.

type StatusForbidden ¶

type StatusForbidden struct{}

StatusForbidden 403.

type StatusFound ¶

type StatusFound struct{}

StatusFound 302.

type StatusGatewayTimeout ¶

type StatusGatewayTimeout struct{}

StatusGatewayTimeout 504.

type StatusGone ¶

type StatusGone struct{}

StatusGone 410.

type StatusHTTPVersionNotSupported ¶

type StatusHTTPVersionNotSupported struct{}

StatusHTTPVersionNotSupported 505.

type StatusIMUsed ¶

type StatusIMUsed struct{}

StatusIMUsed 226.

type StatusInsufficientStorage ¶

type StatusInsufficientStorage struct{}

StatusInsufficientStorage 507.

type StatusInternalServerError ¶

type StatusInternalServerError struct{}

StatusInternalServerError 500.

type StatusLengthRequired ¶

type StatusLengthRequired struct{}

StatusLengthRequired 411.

type StatusLocked ¶

type StatusLocked struct{}

StatusLocked 423.

type StatusLoopDetected ¶

type StatusLoopDetected struct{}

StatusLoopDetected 508.

type StatusMethodNotAllowed ¶

type StatusMethodNotAllowed struct{}

StatusMethodNotAllowed 405.

type StatusMisdirectedRequest ¶

type StatusMisdirectedRequest struct{}

StatusMisdirectedRequest 421.

type StatusMovedPermanently ¶

type StatusMovedPermanently struct{}

StatusMovedPermanently 301.

type StatusMultiStatus ¶

type StatusMultiStatus struct{}

StatusMultiStatus 207.

type StatusMultipleChoices ¶

type StatusMultipleChoices struct{}

StatusMultipleChoices 300.

type StatusNetworkAuthenticationRequired ¶

type StatusNetworkAuthenticationRequired struct{}

StatusNetworkAuthenticationRequired 511.

type StatusNoContent ¶

type StatusNoContent struct{}

StatusNoContent 204.

type StatusNonAuthoritativeInfo ¶

type StatusNonAuthoritativeInfo struct{}

StatusNonAuthoritativeInfo 203.

type StatusNotAcceptable ¶

type StatusNotAcceptable struct{}

StatusNotAcceptable 406.

type StatusNotExtended ¶

type StatusNotExtended struct{}

StatusNotExtended 510.

type StatusNotFound ¶

type StatusNotFound struct{}

StatusNotFound 404.

type StatusNotImplemented ¶

type StatusNotImplemented struct{}

StatusNotImplemented 501.

type StatusNotModified ¶

type StatusNotModified struct{}

StatusNotModified 304.

type StatusOK ¶

type StatusOK struct{}

StatusOK 200.

type StatusPartialContent ¶

type StatusPartialContent struct{}

StatusPartialContent 206.

type StatusPaymentRequired ¶

type StatusPaymentRequired struct{}

StatusPaymentRequired 402.

type StatusPermanentRedirect ¶

type StatusPermanentRedirect struct{}

StatusPermanentRedirect 308.

type StatusPreconditionFailed ¶

type StatusPreconditionFailed struct{}

StatusPreconditionFailed 412.

type StatusPreconditionRequired ¶

type StatusPreconditionRequired struct{}

StatusPreconditionRequired 428.

type StatusProcessing ¶

type StatusProcessing struct{}

StatusProcessing 102.

type StatusProxyAuthRequired ¶

type StatusProxyAuthRequired struct{}

StatusProxyAuthRequired 407.

type StatusRequestEntityTooLarge ¶

type StatusRequestEntityTooLarge struct{}

StatusRequestEntityTooLarge 413.

type StatusRequestHeaderFieldsTooLarge ¶

type StatusRequestHeaderFieldsTooLarge struct{}

StatusRequestHeaderFieldsTooLarge 431.

type StatusRequestTimeout ¶

type StatusRequestTimeout struct{}

StatusRequestTimeout 408.

type StatusRequestURITooLong ¶

type StatusRequestURITooLong struct{}

StatusRequestURITooLong 414.

type StatusRequestedRangeNotSatisfiable ¶

type StatusRequestedRangeNotSatisfiable struct{}

StatusRequestedRangeNotSatisfiable 416.

type StatusResetContent ¶

type StatusResetContent struct{}

StatusResetContent 205.

type StatusSeeOther ¶

type StatusSeeOther struct{}

StatusSeeOther 303.

type StatusServiceUnavailable ¶

type StatusServiceUnavailable struct{}

StatusServiceUnavailable 503.

type StatusSwitchingProtocols ¶

type StatusSwitchingProtocols struct{}

StatusSwitchingProtocols 101.

type StatusTeapot ¶

type StatusTeapot struct{}

StatusTeapot 418.

type StatusTemporaryRedirect ¶

type StatusTemporaryRedirect struct{}

StatusTemporaryRedirect 307.

type StatusTooEarly ¶

type StatusTooEarly struct{}

StatusTooEarly 425.

type StatusTooManyRequests ¶

type StatusTooManyRequests struct{}

StatusTooManyRequests 429.

type StatusUnauthorized ¶

type StatusUnauthorized struct{}

StatusUnauthorized 401.

type StatusUnavailableForLegalReasons ¶

type StatusUnavailableForLegalReasons struct{}

StatusUnavailableForLegalReasons 451.

type StatusUnprocessableEntity ¶

type StatusUnprocessableEntity struct{}

StatusUnprocessableEntity 422.

type StatusUnsupportedMediaType ¶

type StatusUnsupportedMediaType struct{}

StatusUnsupportedMediaType 415.

type StatusUpgradeRequired ¶

type StatusUpgradeRequired struct{}

StatusUpgradeRequired 426.

type StatusUseProxy ¶

type StatusUseProxy struct{}

StatusUseProxy 305.

type StatusVariantAlsoNegotiates ¶

type StatusVariantAlsoNegotiates struct{}

StatusVariantAlsoNegotiates 506.