Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: add release page link #310

Merged
merged 1 commit into from
Feb 23, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 18 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ Swag converts Go annotations to Swagger Documentation 2.0. We've created a varie
- [Supported Web Frameworks](#supported-web-frameworks)
- [How to use it with Gin](#how-to-use-it-with-gin)
- [Implementation Status](#implementation-status)
- [swag cli](#swag-cli)
- [Declarative Comments Format](#declarative-comments-format)
- [General API Info](##general-api-info)
- [API Operation](#api-operation)
Expand All @@ -40,6 +39,7 @@ Swag converts Go annotations to Swagger Documentation 2.0. We've created a varie
```sh
$ go get -u github.com/swaggo/swag/cmd/swag
```
Or download the pre-compiled binaries binray form [release page](https://github.com/swaggo/swag/releases).

3. Run `swag init` in the project's root folder which contains the `main.go` file. This will parse your comments and generate the required files (`docs` folder and `docs/docs.go`).
```sh
Expand All @@ -51,6 +51,23 @@ $ swag init
swag init -g http/api.go
```

## swag cli

```sh
$ swag init -h
NAME:
swag init - Create docs.go

USAGE:
swag init [command options] [arguments...]

OPTIONS:
--generalInfo value, -g value Go file path in which 'swagger general API Info' is written (default: "main.go")
--dir value, -d value Directory you want to parse (default: "./")
--swagger value, -s value Output the swagger conf for json and yaml (default: "./docs/swagger")
--propertyStrategy value, -p value Property Naming Strategy like snakecase,camelcase,pascalcase (default: "camelcase")
```

## Supported Web Frameworks

- [gin](http://github.com/swaggo/gin-swagger)
Expand Down Expand Up @@ -273,23 +290,6 @@ $ swag init
- [x] Grouping Operations With Tags
- [ ] Swagger Extensions

# swag cli

```sh
$ swag init -h
NAME:
swag init - Create docs.go

USAGE:
swag init [command options] [arguments...]

OPTIONS:
--generalInfo value, -g value Go file path in which 'swagger general API Info' is written (default: "main.go")
--dir value, -d value Directory you want to parse (default: "./")
--swagger value, -s value Output the swagger conf for json and yaml (default: "./docs/swagger")
--propertyStrategy value, -p value Property Naming Strategy like snakecase,camelcase,pascalcase (default: "camelcase")
```

# Declarative Comments Format

## General API Info
Expand Down