atreugoswagger

README

atreugo-swagger

atreugo handler that serves swagger files.

Works with swaggo

swagger files are from: swaggofiles

atreugo v11 support

Use atreugo-swagger v2.0.1 and above for atreugo v11 support

Paths

Serves swagger documentation under index.html

Serves redoc documentation under redoc.html

Example

package main

import (
	atreugoswagger "github.com/Nerzal/atreugo-swagger/v2"
	_ "github.com/Nerzal/atreugo-swagger/example/docs" // docs is generated by Swag CLI, you have to import it.
	"github.com/savsgio/atreugo/v11"
)

// @title Swagger Example API
// @version 1.0
// @description This is a sample server Petstore server.
// @termsOfService http://swagger.io/terms/

// @contact.name API Support
// @contact.url http://www.swagger.io/support
// @contact.email support@swagger.io

// @license.name Apache 2.0
// @license.url http://www.apache.org/licenses/LICENSE-2.0.html

// @host petstore.swagger.io
// @BasePath /v2
func main() {
	config := &atreugo.Config{
		Addr: "0.0.0.0:1337",
	}

	a := atreugo.New(config)

	// This will server all swagger files under the /docs/* path.
	a.GET("/docs/*doc", atreugoswagger.AtreugoWrapHandler(atreugoswagger.Title("Test Title")))

	// Start the server
	err := a.ListenAndServe()
	if err != nil {
		panic(err)
	}
}

Documentation

Index

• func AtreugoWrapHandler(confs ...func(c *Config)) func(ctx *atreugo.RequestCtx) error
• func Title(title string) func(c *Config)
• func URL(url string) func(c *Config)
• type Config

Functions

func AtreugoWrapHandler

func AtreugoWrapHandler(confs ...func(c *Config)) func(ctx *atreugo.RequestCtx) error

AtreugoWrapHandler is a handler which serves swagger files

func Title

func Title(title string) func(c *Config)

Title presents the title of the tab

func URL

func URL(url string) func(c *Config)

URL presents the url pointing to API definition (normally swagger.json or swagger.yaml).

Types

type Config

type Config struct {
	// The url pointing to API definition (normally swagger.json or swagger.yaml). Default is `doc.json`.
	URL string
	// Title is used for the redoc documentation
	Title string
}

Config stores atreugoswagger configuration variables.