README
¶
Document
Fns document handler.
Install
go get github.com/aacfactory/fns-contrib/transports/handlers/documents
Use
fns.New(fns.Handler(documents.New()))
Config
transport:
handlers:
documents:
enable: true
openAPI:
version: "openapi version"
title: ""
description: ""
term: ""
URL
Raw document
/documents
Openapi view (latest)
/documents/openapi/index.html
Openapi view (by version)
It will find major and miner matched.
/documents/openapi/index.html?version=v1.0
Openapi document
/documents?openapi=latest
Documentation
¶
Index ¶
- func New() transports.MuxHandler
- type Config
- type Handler
- func (handler *Handler) Construct(options transports.MuxHandlerOptions) (err error)
- func (handler *Handler) Handle(w transports.ResponseWriter, r transports.Request)
- func (handler *Handler) Match(_ context.Context, method []byte, path []byte, _ transports.Header) (ok bool)
- func (handler *Handler) Name() string
- type OpenAPI
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func New ¶
func New() transports.MuxHandler
Types ¶
type Handler ¶
type Handler struct {
// contains filtered or unexported fields
}
Handler method is get url is /documents when /documents?openapi={latest|version_text}, then return openapi
func (*Handler) Construct ¶
func (handler *Handler) Construct(options transports.MuxHandlerOptions) (err error)
func (*Handler) Handle ¶
func (handler *Handler) Handle(w transports.ResponseWriter, r transports.Request)
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.