apispec

Documentation

Index

• func DownloadSwaggerData(output string, dw downloader.PlatformAwareOCIDownloader) (err error)
• func GetProtoFiles() (files map[string]string, err error)
• func GetSwaggerList() (swaggers []string)
• func ParseFileToSwagger(dataFile string) (swagger *spec.Swagger, err error)
• func ParseStreamToSwagger(stream io.Reader) (swagger *spec.Swagger, err error)
• func ParseToSwagger(data []byte) (swagger *spec.Swagger, err error)
• func ParseURLToSwagger(swaggerURL string) (swagger *spec.Swagger, err error)
• func SwaggersHandler(w http.ResponseWriter, _ *http.Request, _ map[string]string)
• type APICoverage
  • func NewFakeAPISpec(apis [][]string) APICoverage
• type SwaggerAPI
  • func NewSwaggerAPI(swagger *spec.Swagger) *SwaggerAPI
  • func (s *SwaggerAPI) APICount() (count int)
  • func (s *SwaggerAPI) HaveAPI(path, method string) (exist bool)

Functions

func DownloadSwaggerData

func DownloadSwaggerData(output string, dw downloader.PlatformAwareOCIDownloader) (err error)

func GetProtoFiles

func GetProtoFiles() (files map[string]string, err error)

func GetSwaggerList

func GetSwaggerList() (swaggers []string)

func ParseFileToSwagger

func ParseFileToSwagger(dataFile string) (swagger *spec.Swagger, err error)

func ParseStreamToSwagger

func ParseStreamToSwagger(stream io.Reader) (swagger *spec.Swagger, err error)

func ParseToSwagger

func ParseToSwagger(data []byte) (swagger *spec.Swagger, err error)

func ParseURLToSwagger

func ParseURLToSwagger(swaggerURL string) (swagger *spec.Swagger, err error)

func SwaggersHandler

func SwaggersHandler(w http.ResponseWriter, _ *http.Request,
	_ map[string]string)

Types

type APICoverage

type APICoverage interface {
	HaveAPI(path, method string) (exist bool)
	APICount() (count int)
}

func NewFakeAPISpec

func NewFakeAPISpec(apis [][]string) APICoverage

NewFakeAPISpec creates a new instance of fakeAPISpec

type SwaggerAPI

type SwaggerAPI struct {
	Swagger *spec.Swagger
	ApiMap  map[string][]string
}

func NewSwaggerAPI

func NewSwaggerAPI(swagger *spec.Swagger) *SwaggerAPI

func (*SwaggerAPI) APICount

func (s *SwaggerAPI) APICount() (count int)

APICount return the count of APIs

func (*SwaggerAPI) HaveAPI

func (s *SwaggerAPI) HaveAPI(path, method string) (exist bool)

HaveAPI check if the swagger has the API. If the path is /api/v1/names/linuxsuren, then will match /api/v1/names/{name}