openapi

README

Golang OpenAPI specification generator

Generate an openapi specification easily with golang codes.

Usage

openapi.Generate("My Example API", OpenAPIRoutes)

Example

go run example/simple.go

Documentation

Index

• func Generate(title string, routes []Route) error
• type OpenAPI
  • func New(title string) OpenAPI
• type Route

Functions

func Generate

func Generate(title string, routes []Route) error

Types

type OpenAPI

type OpenAPI interface {
	// contains filtered or unexported methods
}

func New

func New(title string) OpenAPI

type Route

type Route struct {
	Method          string
	Path            string
	Request         interface{}
	SuccessResponse interface{}
	ErrorResponse   interface{}
}