dochandler

package

v0.3.0 Latest Latest Go to latest Published: Aug 24, 2023 License: Apache-2.0 Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/podhmo/reflect-openapi

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func ListEndpointHandler(doc *openapi3.T, extras ...Endpoint) http.HandlerFunc
func New(doc *openapi3.T, basePath string, info *info.Info, mdtext string) http.Handler
func OpenAPIDocHandler(doc *openapi3.T) http.HandlerFunc
func RedocHandler(doc *openapi3.T, basePath string) http.HandlerFunc
func SwaggerUIHandler(doc *openapi3.T, basePath string) http.HandlerFunc
type Endpoint
- func (r *Endpoint) String() string
type MDDocHandler
- func NewMdDocHandler(doc *openapi3.T, info *info.Info) *MDDocHandler
- func (h *MDDocHandler) HTML(w http.ResponseWriter, r *http.Request)
- func (h *MDDocHandler) Text(w http.ResponseWriter, r *http.Request)

Constants ¶

View Source

const MDDOC_TEMPLATE = `` /* 2871-byte string literal not displayed */

View Source

const REDOC_TEMPLATE = `` /* 566-byte string literal not displayed */

View Source

const SWAGGER_UI_TEMPLATE = `` /* 787-byte string literal not displayed */

Variables ¶

This section is empty.

Functions ¶

func ListEndpointHandler ¶

func ListEndpointHandler(doc *openapi3.T, extras ...Endpoint) http.HandlerFunc

func New ¶

func New(doc *openapi3.T, basePath string, info *info.Info, mdtext string) http.Handler

func OpenAPIDocHandler ¶

func OpenAPIDocHandler(doc *openapi3.T) http.HandlerFunc

func RedocHandler ¶

func RedocHandler(doc *openapi3.T, basePath string) http.HandlerFunc

func SwaggerUIHandler ¶

func SwaggerUIHandler(doc *openapi3.T, basePath string) http.HandlerFunc

Types ¶

type Endpoint ¶

type Endpoint struct {
	Method      string `json:"method"`
	Path        string `json:"path"`
	OperationID string `json:"operationId"`
	Summary     string `json:"summary"`
}

func (*Endpoint) String ¶

func (r *Endpoint) String() string

type MDDocHandler ¶ added in v0.3.0

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

func NewMdDocHandler ¶ added in v0.3.0

func NewMdDocHandler(doc *openapi3.T, info *info.Info) *MDDocHandler

func (*MDDocHandler) HTML ¶ added in v0.3.0

func (h *MDDocHandler) HTML(w http.ResponseWriter, r *http.Request)

func (*MDDocHandler) Text ¶ added in v0.3.0

func (h *MDDocHandler) Text(w http.ResponseWriter, r *http.Request)

Source Files ¶

View all Source files

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