apidoc

type APIRegistry struct {
	Routes map[string]*RouteDoc
	Title  string
	Desc   string
	// contains filtered or unexported fields
}

type MediaTypeDoc struct {
	Schema SchemaDoc `json:"schema"`
}

type ParamDoc struct {
	Name        string `json:"name"`
	In          string `json:"in"` // query, path, header
	Description string `json:"description,omitempty"`
	Required    bool   `json:"required"`
	Type        string `json:"type"` // string, integer
}

type Property struct {
	Type string `json:"type"`
}

type RequestBodyDoc struct {
	Content map[string]MediaTypeDoc `json:"content"`
}

type ResponseDoc struct {
	Description string `json:"description"`
}

type RouteDoc struct {
	Method      string                 `json:"method"`
	Path        string                 `json:"path"`
	Summary     string                 `json:"summary"`
	Description string                 `json:"description"`
	Tags        []string               `json:"tags"`
	Params      []ParamDoc             `json:"parameters,omitempty"`
	RequestBody *RequestBodyDoc        `json:"requestBody,omitempty"`
	Responses   map[string]ResponseDoc `json:"responses"`
}

type SchemaDoc struct {
	Type       string              `json:"type"`
	Properties map[string]Property `json:"properties,omitempty"`
}