httphandler

package
v1.7.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 14, 2026 License: Apache-2.0 Imports: 13 Imported by: 0

README

OpenAPI Operations

Downloadable OpenAPI specifications are available at the following paths relative to the router's prefix:

  • openapi.json — JSON (application/json)
  • openapi.yaml — YAML (application/yaml)
  • openapi.html — HTML (text/html)

GET /openapi.json

Return OpenAPI specification in JSON format

GET /openapi.yaml

Return OpenAPI specification in YAML format

GET /openapi.html

Return OpenAPI specification in HTML format, which can be viewed in a web browser

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func RegisterHandler

func RegisterHandler(router *httprouter.Router) error

RegisterHandler registers GET handlers that serve the router's OpenAPI specification at two paths relative to the router's prefix:

  • openapi.json — JSON (application/json)
  • openapi.yaml — YAML (application/yaml)
  • openapi.html — HTML documentation (text/html)

Types

This section is empty.

Jump to

Keyboard shortcuts

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