Skip to content

About

a tool to extract docs from handler comments

Resources

Stars

3 stars

Watchers

4 watching

Forks

Latest commit

 

History

29 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

tsuru-api-docs

a tool to extract docs from handler comments

Installation

tsuru-api-docs requires Go 1.6 or later.

go get -u github.com/tsuru/tsuru-api-docs

Usage

Print a yaml with the api docs

tsuru-api-docs

Check handlers without docs

tsuru-api-docs | grep missing

List handlers with a specific method

tsuru-api-docs -method GET

List handlers without a specific method

tsuru-api-docs -no-method GET

List handlers matching search regexp

tsuru-api-docs -search "event\.New"

List handlers NOT matching search regexp

tsuru-api-docs -no-search "event\.New"

About

a tool to extract docs from handler comments

Resources

Stars

3 stars

Watchers

4 watching

Forks

Releases

Packages

Used by

Contributors

Languages