docs

Documentation

Overview

Package docs Code generated by swaggo/swag. DO NOT EDIT

Index

• Variables
• type Swagger
  • func NewSwagger() *Swagger
  • func (s *Swagger) AttachHandlers(g *gin.Engine)
  • func (s *Swagger) Docs(context *gin.Context)
  • func (s *Swagger) Index(context *gin.Context)

Variables

var SwaggerInfo = &swag.Spec{
	Version:          "1.0",
	Host:             "",
	BasePath:         "/api",
	Schemes:          []string{},
	Title:            "Feedback",
	Description:      "This is a service dedicated to collecting feedback from Mysterium Network users",
	InfoInstanceName: "swagger",
	SwaggerTemplate:  docTemplate,
	LeftDelim:        "{{",
	RightDelim:       "}}",
}

SwaggerInfo holds exported Swagger Info so clients can modify it

Types

type Swagger

type Swagger struct{}

Swagger object

func NewSwagger

func NewSwagger() *Swagger

NewSwaggerHandler creates a new handler for swagger docs

func (*Swagger) AttachHandlers

func (s *Swagger) AttachHandlers(g *gin.Engine)

func (*Swagger) Docs

func (s *Swagger) Docs(context *gin.Context)

Docs use ginSwagger middleware to serve the API docs

func (*Swagger) Index

func (s *Swagger) Index(context *gin.Context)

Index redirects root route to swagger docs