d01markdown-with-html

README

---

title: hello version: 1.0.0

hello

This is the example has text/html output

• paths
• schemas

paths

endpoint	operationId	tags	summary
POST /api/hello	main.Hello	main
GET /hello/{name}	main.HelloHTML	main text/html
GET /hello2/{name}	main.HelloHTML2	main text/html	with custom error response (responses['default'])
GET /hello3/{name}	main.HelloHTML3	main text/html	with response header
POST /login	main.Login	main text/html	Successfully authenticated.

main.Hello POST /api/hello

name	value
operationId	main.Hello
endpoint	POST /api/hello
input	Input
output	<Anonymous>
tags	main

input (application/json)

// POST /api/hello
type Input struct {
	JSONBody struct {	// 
		name string
	}
}

output (application/json)

// POST /api/hello (200)
type Output200 struct {	// 
	message string
}

main.HelloHTML GET /hello/{name}

name	value
operationId	main.HelloHTML
endpoint	GET /hello/{name}
input	Input
output	string
tags	main

input

// GET /hello/{name}
type Input struct {
	name string `in:"path"`
}

output (text/html)

html with greeting message

main.HelloHTML2 GET /hello2/{name}

with custom error response (responses['default'])

name	value
operationId	main.HelloHTML2
endpoint	GET /hello2/{name}
input	Input
output	string
tags	main

input

// GET /hello2/{name}
type Input struct {
	name string `in:"path"`
}

output (text/html)

html with greeting message

description

with custom error response (responses['default'])

main.HelloHTML3 GET /hello3/{name}

with response header

name	value
operationId	main.HelloHTML3
endpoint	GET /hello3/{name}
input	Input
output	string
tags	main

input

// GET /hello3/{name}
type Input struct {
	name string `in:"path"`
}

output (text/html)

html with greeting message

description

with response header

main.Login POST /login

Successfully authenticated.

name	value
operationId	main.Login
endpoint	POST /login
input	Input[ LoginInput ]
output	string
tags	main

input

// POST /login
type Input struct {
	JSONBody struct {	// LoginInput
		name string

		password string
	}
}

output (text/html)

description

Successfully authenticated. The session ID is returned in a cookie named JSESSIONID. You need to include this cookie in subsequent request

---

schemas

name	summary
Error	is custom error response
LoginInput	https://swagger.io/docs/specification/authentication/cookie-authentication/

Error

is custom error response

// Error is custom error response
type Error struct {
	message string
}

• output of main.HelloHTML2 (default) as Error
• output of main.HelloHTML3 (default) as Error

LoginInput

https://swagger.io/docs/specification/authentication/cookie-authentication/

// https://swagger.io/docs/specification/authentication/cookie-authentication/
type LoginInput struct {
	name string

	password string
}

• input of main.Login as LoginInput