https://github.com/tsuru/tsuru-api-docs

a tool to extract docs from handler comments
https://github.com/tsuru/tsuru-api-docs

Last synced: 3 months ago
JSON representation

a tool to extract docs from handler comments

• Host: GitHub
• URL: https://github.com/tsuru/tsuru-api-docs
• Owner: tsuru
• License: bsd-3-clause
• Created: 2016-03-17T22:33:09.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2023-05-30T18:34:58.000Z (about 1 year ago)
• Last Synced: 2024-01-16T12:16:45.663Z (5 months ago)
• Language: Go
• Size: 165 KB
• Stars: 3
• Watchers: 6
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-stars - tsuru-api-docs

README

        
# 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"

```