Directories
¶
| Path | Synopsis |
|---|---|
|
Package astutil provides small go/ast + go/types helpers shared across gota's router plugins and orchestration layer.
|
Package astutil provides small go/ast + go/types helpers shared across gota's router plugins and orchestration layer. |
|
Package emitter builds the final OpenAPI 3.1 document from merged operations and serializes it to YAML or JSON.
|
Package emitter builds the final OpenAPI 3.1 document from merged operations and serializes it to YAML or JSON. |
|
Package extractor pulls "gota:" blocks out of Go doc comments and parses them as OpenAPI Operation fragments.
|
Package extractor pulls "gota:" blocks out of Go doc comments and parses them as OpenAPI Operation fragments. |
|
Package generate orchestrates the full gota pipeline: load packages, run router plugins to find routes, extract "gota:" comment blocks, infer defaults, merge the two, and hand the result to the emitter.
|
Package generate orchestrates the full gota pipeline: load packages, run router plugins to find routes, extract "gota:" comment blocks, infer defaults, merge the two, and hand the result to the emitter. |
|
Package inference derives a baseline OpenAPI Operation from what can be deduced statically from a route and its handler, with no help from the programmer: path parameters, a default response, and a few conventional defaults (operationId, summary).
|
Package inference derives a baseline OpenAPI Operation from what can be deduced statically from a route and its handler, with no help from the programmer: path parameters, a default response, and a few conventional defaults (operationId, summary). |
|
Package merger combines an inferred Operation with a declared ("gota:" comment) Operation.
|
Package merger combines an inferred Operation with a declared ("gota:" comment) Operation. |
|
Package parser loads a Go module's packages with full AST and type information, ready for router plugins and the inference stage to walk.
|
Package parser loads a Go module's packages with full AST and type information, ready for router plugins and the inference stage to walk. |
|
Package router defines the plugin interface framework adapters implement to tell gota which HTTP routes exist in a Go program.
|
Package router defines the plugin interface framework adapters implement to tell gota which HTTP routes exist in a Go program. |
|
chi
Package chi is a router plugin for github.com/go-chi/chi/v5.
|
Package chi is a router plugin for github.com/go-chi/chi/v5. |
|
gin
Package gin is a router plugin for github.com/gin-gonic/gin.
|
Package gin is a router plugin for github.com/gin-gonic/gin. |
|
gorilla
Package gorilla is a router plugin for github.com/gorilla/mux.
|
Package gorilla is a router plugin for github.com/gorilla/mux. |
|
nethttp
Package nethttp is gota's Phase 1 router plugin.
|
Package nethttp is gota's Phase 1 router plugin. |
Click to show internal directories.
Click to hide internal directories.