Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CreateOpenApiDoc ¶
func GenerateOpenAPI ¶
func RegisterApi ¶
func RegisterApi(api ApiWrapper)
Types ¶
type ApiParameter ¶
type ApiRequestBody ¶
type ApiRequestBody struct {
Description string `json:"description,omitempty"`
Content interface{} `json:"content,omitempty"`
}
type ApiResponse ¶
type ApiResponse struct {
Description string `json:"description,omitempty"`
Content interface{} `json:"content,omitempty"`
}
Response represents the response structure for an API
type ApiWrapper ¶
type ApiWrapper struct {
Path string `json:"path"`
Method string `json:"method"`
Name string `json:"name"`
Description string `json:"description"`
Tags []string `json:"tags,omitempty"`
RequestBody *ApiRequestBody `json:"requestBody,omitempty"`
Response *ApiResponse `json:"response,omitempty"`
Parameters []ApiParameter `json:"parameters,omitempty"`
UnAuthenticated bool `json:"unauthenticated,omitempty"`
ProjectIDNotRequired bool `json:"projectIdNotRequired,omitempty"`
}
Click to show internal directories.
Click to hide internal directories.