docs

package

v0.1.13 Latest Latest Go to latest Published: Jun 19, 2023 License: Apache-2.0 Imports: 4 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/kubescape/gateway

Links

Open Source Insights

Documentation ¶

Overview ¶

Package classification Kubescape Gateway

The Kubescape Gateway listens and routes messages to its intended recipients.

Schemes: https, http BasePath: / Version: 1.0.0

Consumes: - application/json Produces: - text/plain

Security: - basic

swagger:meta

Package docs documents the HTTP API endpoints. The documentation is then used to generate an OpenAPI spec.

Index ¶

Constants
func NewOpenAPIUIHandler() http.Handler
func ServeOpenAPISpec(w http.ResponseWriter, r *http.Request)

Constants ¶

View Source

const (
	OpenAPIDocsEndpoint        = "docs"
	OpenAPIRapiEndpoint        = "rapi"
	OpenAPISwaggerUIEndpoint   = "swaggerui"
	OpenAPIswaggerJSONEndpoint = "swagger.yaml"
	OpenAPIV2Prefix            = "/openapi/v2/"
)

Variables ¶

This section is empty.

Functions ¶

func NewOpenAPIUIHandler ¶

func NewOpenAPIUIHandler() http.Handler

NewOpenAPIUIHandler returns a handler that serves OpenAPI specs via UI

func ServeOpenAPISpec ¶

func ServeOpenAPISpec(w http.ResponseWriter, r *http.Request)

ServeOpenAPISpec returns the OpenAPI specification file

Types ¶

This section is empty.

Source Files ¶

View all Source files

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