apispec

Documentation

Index

• func GetProtoFiles() (files map[string]string, err error)
• type APIConverage
  • func NewFakeAPISpec(apis [][]string) APIConverage
• type Parameter
• type Schema
• type Swagger
  • func ParseStreamToSwagger(stream io.Reader) (swagger *Swagger, err error)
  • func ParseToSwagger(data []byte) (swagger *Swagger, err error)
  • func ParseURLToSwagger(swaggerURL string) (swagger *Swagger, err error)
  • func (s *Swagger) APICount() (count int)
  • func (s *Swagger) HaveAPI(path, method string) (exist bool)
• type SwaggerAPI
• type SwaggerInfo

Functions

func GetProtoFiles

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

Types

type APIConverage

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

func NewFakeAPISpec

func NewFakeAPISpec(apis [][]string) APIConverage

NewFakeAPISpec creates a new instance of fakeAPISpec

type Parameter

type Parameter struct {
	Name string `json:"name"`
	// In represents the parameter type, supported values: query, path
	In       string `json:"in"`
	Required bool   `json:"required"`
	Schema   Schema `json:"schema"`
}

type Schema

type Schema struct {
	Type   string `json:"type"`
	Format string `json:"format"`
}

type Swagger

type Swagger struct {
	Swagger string `json:"swagger"`
	// Paths includes all the API requests.
	// The keys is the HTTP request method which as lower-case, for example: get, post.
	Paths map[string]map[string]SwaggerAPI `json:"paths"`
	Info  SwaggerInfo                      `json:"info"`
}

func ParseStreamToSwagger

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

func ParseToSwagger

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

func ParseURLToSwagger

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

func (*Swagger) APICount

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

APICount return the count of APIs

func (*Swagger) HaveAPI

func (s *Swagger) 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}

type SwaggerAPI

type SwaggerAPI struct {
	OperationId string      `json:"operationId"`
	Parameters  []Parameter `json:"parameters"`
	Summary     string      `json:"summary"`
}

type SwaggerInfo

type SwaggerInfo struct {
	Description string `json:"description"`
	Title       string `json:"title"`
	Version     string `json:"version"`
}