openapi

package

v0.0.0-...-b52a20e Latest Latest Go to latest Published: Apr 9, 2026 License: MIT Imports: 7 Imported by: 0

Details

This section is empty.

View Source

var SwaggerUIHTML embed.FS

func SwaggerUIHandler() ([]byte, error)

SwaggerUIHandler returns the Swagger UI HTML content

type Config struct {
	Title          string
	Description    string
	Version        string
	OpenAPIVersion string
}

Config for Spec

func DefaultConfig() Config

DefaultConfig returns default configuration

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

Spec wraps OpenAPI specification

func NewSpec(config Config) *Spec

NewSpec creates a new OpenAPI Spec

func (s *Spec) AddServer(url, description string)

AddServer adds a server

func (s *Spec) MarshalJSON() ([]byte, error)

MarshalJSON returns JSON format of OpenAPI spec

func (s *Spec) RegisterOperation(method, path, summary, description string, tags []string, reqType, respType any)

RegisterOperation registers an operation to OpenAPI spec

func (s *Spec) SetInfo(title, description, version string)

SetInfo sets API information

func (s *Spec) Spec() *openapi3.T

Spec returns the underlying openapi3.T (read-only, do not modify)