Help us shape the future of Go! Take the 2026 Go Developer Survey

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

swaggerkit

package module

Go to main page

Versions in this module

v1

v1.1.0

Sep 26, 2026

Changes in this version

+ func SetStatus(ctx context.Context, code int)

+ func WriteError(w http.ResponseWriter, err error)

type API

+ func (a *API) Document(f Format) ([]byte, error)

+ func (a *API) DocumentHandler(f Format) http.Handler

+ type Documented interface

+ Doc func() string

+ type Format string

+ const FormatOpenAPI30

+ const FormatOpenAPI31

+ const FormatSwagger20

type RouteOption

+ func Header(name, description string) RouteOption

+ func MaxBodyBytes(n int64) RouteOption

+ func Statuses(codes ...int) RouteOption

v1.0.0

Sep 26, 2026

Changes in this version

+ const OpenAPIVersion

+ func Delete[In, Out any](r Router, path string, h HandlerFunc[In, Out], opts ...RouteOption)

+ func Get[In, Out any](r Router, path string, h HandlerFunc[In, Out], opts ...RouteOption)

+ func Handle[In, Out any](r Router, method, path string, h HandlerFunc[In, Out], opts ...RouteOption)

+ func Patch[In, Out any](r Router, path string, h HandlerFunc[In, Out], opts ...RouteOption)

+ func Post[In, Out any](r Router, path string, h HandlerFunc[In, Out], opts ...RouteOption)

+ func Put[In, Out any](r Router, path string, h HandlerFunc[In, Out], opts ...RouteOption)

+ func Request(ctx context.Context) *http.Request

+ func ResponseHeader(ctx context.Context) http.Header

+ type API struct

+ func New(info Info, opts ...Option) *API

+ func (a *API) Group(prefix string, opts ...RouteOption) *Group

+ func (a *API) Lint() []Issue

+ func (a *API) OpenAPI() ([]byte, error)

+ func (a *API) OpenAPIHandler() http.Handler

+ func (a *API) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ func (a *API) Use(mw ...Middleware)

+ func (a *API) WriteOpenAPI(w io.Writer) error

+ type Contact struct

+ Email string

+ Name string

+ URL string

+ type Error struct

+ Detail string

+ Err error

+ Errors []FieldError

+ Status int

+ Title string

+ Type string

+ func BadRequest(detail string) *Error

+ func Conflict(detail string) *Error

+ func Errorf(status int, format string, args ...any) *Error

+ func Forbidden(detail string) *Error

+ func NewError(status int, detail string) *Error

+ func NotFound(detail string) *Error

+ func Unauthorized(detail string) *Error

+ func (e *Error) Error() string

+ func (e *Error) Unwrap() error

+ type FieldError struct

+ Location string

+ Message string

+ type File struct

+ Body io.Reader

+ ContentType string

+ Inline bool

+ ModTime time.Time

+ Name string

+ type Group struct

+ func (g *Group) Group(prefix string, opts ...RouteOption) *Group

+ type HandlerFunc func(ctx context.Context, in In) (Out, error)

+ type Info struct

+ Contact *Contact

+ Description string

+ License *License

+ TermsOfService string

+ Title string

+ Version string

+ type Issue struct

+ Location string

+ Message string

+ Rule string

+ Severity Severity

+ func (i Issue) String() string

+ type License struct

+ Identifier string

+ Name string

+ URL string

+ type Middleware = func(http.Handler) http.Handler

+ type NoContent struct

+ type Option func(*API)

+ func WithBasePath(prefix string) Option

+ func WithDocs(path string) Option

+ func WithLogger(l *slog.Logger) Option

+ func WithMaxBodyBytes(n int64) Option

+ func WithSecurityScheme(name string, scheme SecurityScheme) Option

+ func WithServer(url, description string) Option

+ func WithTag(name, description string) Option

+ func WithUnknownFields() Option

+ type RouteOption func(*routeConfig)

+ func Deprecated() RouteOption

+ func Description(s string) RouteOption

+ func Errors(codes ...int) RouteOption

+ func Hidden() RouteOption

+ func Middlewares(mw ...Middleware) RouteOption

+ func OperationID(id string) RouteOption

+ func Produces(contentType string) RouteOption

+ func Public() RouteOption

+ func Security(schemes ...string) RouteOption

+ func Status(code int) RouteOption

+ func Summary(s string) RouteOption

+ func Tags(tags ...string) RouteOption

+ type Router interface

+ type Schema struct

+ AdditionalProperties *Schema

+ Default any

+ Deprecated bool

+ Description string

+ Enum []any

+ Examples []any

+ ExclusiveMaximum *float64

+ ExclusiveMinimum *float64

+ Format string

+ Items *Schema

+ MaxItems *int

+ MaxLength *int

+ MaxProperties *int

+ Maximum *float64

+ MinItems *int

+ MinLength *int

+ MinProperties *int

+ Minimum *float64

+ MultipleOf *float64

+ Nullable bool

+ Pattern string

+ Properties map[string]*Schema

+ Ref string

+ Required []string

+ Title string

+ Type string

+ UniqueItems bool

+ func (s *Schema) MarshalJSON() ([]byte, error)

+ type SchemaProvider interface

+ JSONSchema func() *Schema

+ type SecurityScheme struct

+ BearerFormat string

+ Description string

+ In string

+ Name string

+ OpenIDConnectURL string

+ Scheme string

+ Type string

+ func APIKeyAuth(in, name string) SecurityScheme

+ func BasicAuth() SecurityScheme

+ func BearerAuth(format string) SecurityScheme

+ func OpenIDConnectAuth(discoveryURL string) SecurityScheme

+ type Server struct

+ Description string

+ URL string

+ type Severity string

+ const SeverityError

+ const SeverityInfo

+ const SeverityWarning