onlinedoc

Documentation

Index

• Variables
• func Routes() []model.Route
• type OnlineDocHandler
  • func NewOnlineDocHandler() OnlineDocHandler
• type OnlineDocHandlerImpl
  • func (receiver *OnlineDocHandlerImpl) GetDoc(_writer http.ResponseWriter, _req *http.Request)
  • func (receiver *OnlineDocHandlerImpl) GetOpenAPI(_writer http.ResponseWriter, _req *http.Request)

Variables

var Oas string

Oas store OpenAPI3.0 description json string

Functions

func Routes

func Routes() []model.Route

Routes return route slice for gorilla mux

Types

type OnlineDocHandler

type OnlineDocHandler interface {
	GetDoc(w http.ResponseWriter, r *http.Request)
	GetOpenAPI(w http.ResponseWriter, r *http.Request)
}

OnlineDocHandler define http handler interface

func NewOnlineDocHandler

func NewOnlineDocHandler() OnlineDocHandler

NewOnlineDocHandler creates new instance for OnlineDocHandlerImpl

type OnlineDocHandlerImpl

type OnlineDocHandlerImpl struct {
}

OnlineDocHandlerImpl define implementation for OnlineDocHandler

func (*OnlineDocHandlerImpl) GetDoc

func (receiver *OnlineDocHandlerImpl) GetDoc(_writer http.ResponseWriter, _req *http.Request)

GetDoc return documentation web UI

func (*OnlineDocHandlerImpl) GetOpenAPI

func (receiver *OnlineDocHandlerImpl) GetOpenAPI(_writer http.ResponseWriter, _req *http.Request)

GetOpenAPI return OpenAPI3.0 description json string