Code
Hub
Workspaces
Following
Trending
Connect
MCP
copy
Create free account
hub
/
github.com/devopsfaith/api2html
/ types & classes
Types & classes
54 in github.com/devopsfaith/api2html
⨍
Functions
150
◇
Types & classes
54
↓ 1 callers
FuncType
RendererFunc
RendererFunc is a function implementing the Renderer interface
engine/engine.go:83
↓ 1 callers
TypeAlias
TmplScanner
generator/scan.go:23
FuncType
Backend
Backend defines the signature of the function that creates a response for a request to a given backend
engine/engine.go:75
Struct
BasicGenerator
generator/generator.go:28
Interface
Collector
Collector defines the interface for collecting config and translation data
generator/collector.go:15
Struct
Config
Config is a struct with all the required definitions for building an API2HTML engine
engine/engine.go:31
Struct
Data
Data contains all the collected data
generator/collector.go:24
FuncType
Decoder
Decoder defines the signature for response decoder functions
engine/decode.go:9
FuncType
Dumper
func(string, string, Data) error
generator/render.go:25
Struct
DynamicResponseGenerator
DynamicResponseGenerator is a ResponseGenerator that creates a response by adding the decoded data returned by the Backend wo the default response val
engine/response.go:75
Struct
ErrorHandler
ErrorHandler is a Handler that writes the injected content. It's intended to be dispatched by the gin special handlers (NoRoute, NoMethod) but they ca
engine/handler.go:176
Struct
ErrorRenderer
ErrorRenderer is a renderer that always returns the injected error
engine/engine.go:97
Struct
Factory
Factory is a struct able to build api2html engines
engine/factory.go:25
Interface
Generator
generator/generator.go:11
Struct
Handler
Handler is a struct that combines a renderer and a response generator for handling http requests. The handler is able to keep itself subscribed to th
engine/handler.go:98
Struct
HandlerConfig
HandlerConfig defines a Handler
engine/handler.go:16
Struct
LayoutMustacheRenderer
LayoutMustacheRenderer is a mustache renderer composing a mustache template with a layout
engine/mustache.go:68
TypeAlias
Map
generator/collector.go:38
Struct
MustachePageFactory
MustachePageFactory is a component that sets up the gin engine and the template store
engine/page.go:16
Struct
MustacheRenderer
MustacheRenderer is a simple mustache renderer with a single mustache template
engine/mustache.go:45
Struct
NewRelic
NewRelic contains the info regarding the app name and the newrelic license key
engine/engine.go:50
Struct
Page
Page defines the behaviour of the engine for a given URL pattern
engine/engine.go:56
Struct
PublicFolder
PublicFolder contains the info regarding the static contents to be served
engine/engine.go:44
Struct
Render
generator/render.go:27
Interface
Renderer
generator/render.go:13
Interface
Renderer
Renderer defines the interface for the template renderers
engine/engine.go:78
Struct
ResponseContext
ResponseContext is the struct ready to rendered and returned to the Handler
engine/response.go:14
FuncType
ResponseGenerator
ResponseGenerator is a function that, given a gin request, returns a response struc and an error
engine/response.go:40
Interface
Scanner
generator/scan.go:10
Struct
SimpleCollector
generator/collector.go:53
Interface
Skel
Skel defines the interface for creating skeleton files
skeleton/skeleton.go:50
Struct
StaticHandler
StaticHandler is a Handler that writes the injected content
engine/handler.go:150
Struct
StaticResponseGenerator
StaticResponseGenerator is a ResponseGenerator that creates a response just by adding the default response values to the ResponseContext and a zero va
engine/response.go:50
Struct
Subscription
Subscription is a struct to be used to be notified after a change in the watched renderer
engine/engine.go:89
Struct
TemplateStore
TemplateStore manages the loaded templates and the subscriptions
engine/template_store.go:23
Struct
TmplFolder
generator/scan.go:14
TypeAlias
dummyScanner
func TestRender(t *testing.T) { dir, err := ioutil.TempDir("test", "render_output") if err != nil { log.Fatal(err) } defer os.RemoveAll(dir) //
generator/render_test.go:99
FuncType
engineFactory
func(cfgPath string, devel bool) (engineWrapper, error)
cmd/serve.go:41
Interface
engineWrapper
cmd/serve.go:37
Struct
erroredEngine
cmd/serve_test.go:83
Struct
erroredGenerator
cmd/generate_test.go:185
Struct
erroredSkel
cmd/skeleton_test.go:49
FuncType
generatorFactory
func(basePath string, ignoreRegex string) generator.Generator
cmd/generate.go:46
Struct
generatorWatchWrapper
cmd/generate.go:68
Struct
generatorWrapper
cmd/generate.go:52
Struct
partialProvider
engine/mustache.go:86
Struct
serveWrapper
cmd/serve.go:47
Struct
simpleSkel
cmd/skeleton_test.go:57
FuncType
skelFactory
func(outputPath string) skeleton.Skel
cmd/skeleton.go:41
Struct
skelWrapper
cmd/skeleton.go:47
Struct
spyGenerator
cmd/generate_test.go:193
Struct
statikSkel
skeleton/skeleton.go:54
Struct
templateStore
engine/template_store.go:59
Struct
tplHelper
engine/response.go:120