docs

package
v0.0.0-...-741e748 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 20, 2021 License: MIT Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func AddDocs

func AddDocs(route, funcName string) error

Extract comments to form docs

func GenerateDocs

func GenerateDocs()

Write docs to a json file

Types

type Docs

type Docs struct {
	Content RouteInfo `yaml:"Content"`
}

type RouteInfo

type RouteInfo struct {
	Response      string `yaml:"Response"`
	URLParameters string `yaml:"URL Parameters"`

	Name  string
	Route string

	RequestBody []struct {
		Name string `yaml:"Name"`
		Type string `yaml:"Type"`
		Desc string `yaml:"Description"`
	} `yaml:"Request Body"`

	Description string `yaml:"Description"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL