generator

Documentation

Index

• func Build(mod *loader.Module, operations []analyzer.Operation) ([]byte, error)
• type Components
• type Document
• type Info
• type MediaType
• type Operation
• type PathItem
• type RequestBody
• type Response

Functions

func Build

func Build(mod *loader.Module, operations []analyzer.Operation) ([]byte, error)

Types

type Components

type Components struct {
	Schemas map[string]*graph.Schema `json:"schemas,omitempty"`
}

type Document

type Document struct {
	OpenAPI    string              `json:"openapi"`
	Info       Info                `json:"info"`
	Paths      map[string]PathItem `json:"paths"`
	Components Components          `json:"components,omitempty"`
}

type Info

type Info struct {
	Title   string `json:"title"`
	Version string `json:"version"`
}

type MediaType

type MediaType struct {
	Schema *graph.Schema `json:"schema,omitempty"`
}

type Operation

type Operation struct {
	OperationID string              `json:"operationId,omitempty"`
	Tags        []string            `json:"tags,omitempty"`
	RequestBody *RequestBody        `json:"requestBody,omitempty"`
	Responses   map[string]Response `json:"responses"`
}

type PathItem

type PathItem map[string]Operation

type RequestBody

type RequestBody struct {
	Required bool                 `json:"required"`
	Content  map[string]MediaType `json:"content"`
}

type Response

type Response struct {
	Description string               `json:"description"`
	Content     map[string]MediaType `json:"content,omitempty"`
}