swagger

package
v0.28.1 Latest Latest
Warning

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

Go to latest
Published: Aug 11, 2026 License: MIT Imports: 11 Imported by: 0

Documentation

Overview

Package swagger provides Swagger/OpenAPI documentation integration for Gin.

Index

Constants

View Source
const (
	// IndexFileName is the filename for the Swagger UI index page.
	IndexFileName = "index.html"
	// DocJSON is the filename for the Swagger JSON documentation endpoint.
	DocJSON = "doc.json"
	// CSS is the filename for the Swagger UI stylesheet.
	CSS = "swagger-ui.css"
	// Preset is the filename for the Swagger UI standalone preset JavaScript.
	Preset = "swagger-ui-standalone-preset.js"
	// Bundle is the filename for the Swagger UI bundle JavaScript.
	Bundle = "swagger-ui-bundle.js"
	// Fav32 is the filename for the 32x32 favicon.
	Fav32 = "favicon-32x32.png"
	// Fav16 is the filename for the 16x16 favicon.
	Fav16 = "favicon-16x16.png"
)

Variables

This section is empty.

Functions

func FiberHandler

func FiberHandler(docs string) fiber.Handler

FiberHandler returns a Fiber handler function that serves Swagger UI and documentation.

func GinHandler

func GinHandler(base, name string, spec *swag.Spec) gin.HandlerFunc

GinHandler returns a Gin handler function that serves Swagger UI and documentation.

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL