amiswagger

README

amiswagger

ami swagger package to generate documentation

Documentation

Overview

Package amiswagger

Index

• func GenerateOpenApi(params Parameter, listHandler []Handler) (err error)
• func PrintJson(models interface{})
• func StructDetail(str interface{})
• type Authorization
• type ErrorData
• type Handler
  • func NewOpenApiHandler(handler api.Handler, summary string, req interface{}, resp []OpenApiResponse) Handler
• type OpenApiResponse
• type Parameter
  • func NewOpenApiParams(title string, description string, filename string, servers []openapi3.Server) Parameter
• type ResponseData
• type ResponseDataList

Functions

func GenerateOpenApi

func GenerateOpenApi(params Parameter, listHandler []Handler) (err error)

func PrintJson

func PrintJson(models interface{})

func StructDetail

func StructDetail(str interface{})

Types

type Authorization

type Authorization struct {
	Authorization string `header:"Authorization"`
}

type ErrorData

type ErrorData struct {
	Error   string `json:"error"`
	Message string `json:"message,omitempty"`
}

type Handler

type Handler struct {
	api.Handler
	Summary       string
	Request       interface{}
	Response      []OpenApiResponse
	Authorization *string `json:"authorization"`
}

func NewOpenApiHandler

func NewOpenApiHandler(handler api.Handler, summary string, req interface{}, resp []OpenApiResponse) Handler

type OpenApiResponse

type OpenApiResponse struct {
	Code   int
	Output interface{}
}

type Parameter

type Parameter struct {
	Title       string
	Description string
	Filename    string
	Servers     []openapi3.Server
}

func NewOpenApiParams

func NewOpenApiParams(title string, description string, filename string, servers []openapi3.Server) Parameter

type ResponseData

type ResponseData struct {
	Error   string `json:"error"`
	Message string `json:"message,omitempty"`
}

type ResponseDataList

type ResponseDataList struct {
	Error   string  `json:"error"`
	Message string  `json:"message,omitempty"`
	Total   *uint64 `json:"total,omitempty"`
}