openapiv2

Documentation

Overview

* @Author: guihouchang guihouchang@163.com * @Date: 2025-10-29 15:59:57 * @LastEditors: guihouchang guihouchang@163.com * @LastEditTime: 2025-10-29 16:09:48 * @FilePath: /swagger-api/openapiv2/swagger_ui_template.go * @Description: 这是默认设置,请设置`customMade`, 打开koroFileHeader查看配置 进行设置: https://github.com/OBKoro1/koro1FileHeader/wiki/%E9%85%8D%E7%BD%AE

Index

• func NewHandler(handlerOpts ...HandlerOption) http.Handler
• type HandlerOption
  • func WithGeneratorOptions(opts ...generator.Option) HandlerOption
  • func WithPathPrefix(prefix string) HandlerOption
• type Service
  • func New(srv *grpc.Server, opts ...generator.Option) *Service
  • func (s *Service) GetServiceOpenAPI(ctx context.Context, in *metadata.GetServiceDescRequest, onlyRPC bool) (string, error)
  • func (s *Service) ListServices(ctx context.Context, in *metadata.ListServicesRequest) (*metadata.ListServicesReply, error)

Functions

func NewHandler

func NewHandler(handlerOpts ...HandlerOption) http.Handler

Types

type HandlerOption

type HandlerOption func(opt *options)

func WithGeneratorOptions

func WithGeneratorOptions(opts ...generator.Option) HandlerOption

func WithPathPrefix

func WithPathPrefix(prefix string) HandlerOption

type Service

type Service struct {
	// contains filtered or unexported fields
}

Service is service

func New

func New(srv *grpc.Server, opts ...generator.Option) *Service

New service

func (*Service) GetServiceOpenAPI

func (s *Service) GetServiceOpenAPI(ctx context.Context, in *metadata.GetServiceDescRequest, onlyRPC bool) (string, error)

GetServiceOpenAPI get service open api

func (*Service) ListServices

func (s *Service) ListServices(ctx context.Context, in *metadata.ListServicesRequest) (*metadata.ListServicesReply, error)

ListServices list services