docs

package
v0.0.2-beta.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 27, 2025 License: MIT Imports: 16 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Setup 

func Setup(route gin.IRoutes, doc *swag.Spec)

Setup registers Swagger UI endpoints for a given Swagger specification.

Types

type Config 

type Config struct {
	Address string
	Targets []Target
}

Config contains the configuration for the documentation web service.

type Target 

type Target struct {
	Address string
	Spec    *swag.Spec
}

Target represents a documentation target with its address and Swagger specification.

type Web 

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

Web provides a documentation web server that aggregates multiple Swagger specifications.

func NewWebServer 

func NewWebServer(conf *Config) *Web

NewWebServer creates a new documentation web server with the given configuration.

func (*Web) Identifier 

func (w *Web) Identifier() string

Identifier returns the service identifier for the documentation web server.

func (*Web) Start 

func (w *Web) Start(ctx context.Context) error

Start begins serving the documentation web server with Swagger UI for all configured targets. It sets up proxying to target services and provides a unified documentation interface.

func (*Web) Stop 

func (w *Web) Stop(ctx context.Context) error

Stop gracefully shuts down the documentation web server.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.