openapi

package
v1.22.2 Latest Latest
Warning

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

Go to latest
Published: Feb 19, 2026 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Endpoint

type Endpoint struct {
	Type           string
	Name           string
	Route          string
	Summary        string
	Description    string
	InputArgs      any
	OutputArgs     any
	Method         string
	RequiredClaims string
}

Endpoint describes a single endpoint of a microservice, such as an RPC function.

type Service

type Service struct {
	ServiceName string
	Description string
	Version     int
	Endpoints   []*Endpoint
	RemoteURI   string
}

Service is populated with the microservice's specs in order to generate its OpenAPI document.

func (*Service) MarshalJSON

func (s *Service) MarshalJSON() ([]byte, error)

MarshalJSON produces the JSON representation of the OpenAPI document of the service.

Jump to

Keyboard shortcuts

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