03echo-mixed

title: Sample API version: 0.0.0

Sample API

• paths
• schemas

paths

main.ListUsers GET /users

ListUsers returns a list of users.

output (application/json)

// GET /users (200)
type Output200 []struct {	// User
	id integer

	// for go-playground/validator
	name string
}

// GET /users (default)
// default error
type OutputDefault struct {	// APIError
	message string

	details map[string]struct {	// FieldError
		path string

		message string
	}
}

description

ListUsers returns a list of users.

main.InsertUser POST /users

InsertUser inserts user.

input (application/json)

// POST /users
type Input struct {
	JSONBody struct {	// User
		id integer

		// for go-playground/validator
		name string
	}
}

output (application/json)

// POST /users (200)
type Output200 struct {	// User
	id integer

	// for go-playground/validator
	name string
}

// POST /users (default)
// default error
type OutputDefault struct {	// APIError
	message string

	details map[string]struct {	// FieldError
		path string

		message string
	}
}

description

InsertUser inserts user.

main.GetUser GET /users/{userId}

GetUser returns user

input (application/json)

// GET /users/{userId}
type Input struct {
	userId integer `in:"path"`
}

output (application/json)

// GET /users/{userId} (200)
type Output200 struct {	// User
	id integer

	// for go-playground/validator
	name string
}

// GET /users/{userId} (default)
// default error
type OutputDefault struct {	// APIError
	message string

	details map[string]struct {	// FieldError
		path string

		message string
	}
}

description

GetUser returns user

schemas

APIError

type APIError struct {
	message string

	details map[string]struct {	// FieldError
		path string

		message string
	}
}

• output of main.ListUsers (default) as APIError
• output of main.InsertUser (default) as APIError
• output of main.GetUser (default) as APIError

FieldError

type FieldError struct {
	path string

	message string
}

User

type User struct {
	id integer

	// for go-playground/validator
	name string
}

• output of main.ListUsers (200) as []User
• input of main.InsertUser as User
• output of main.InsertUser (200) as User
• output of main.GetUser (200) as User