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.

Sign up for GitHub

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

Jump to bottom

delete swag cli section #330

Closed
wants to merge 3 commits into from
Closed

delete swag cli section #330

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cf318c5
delete swag cli section
pei0804 Mar 20, 2019
be6bdb8
Merge branch 'master' into delete-swag-cli-section
pei0804 Mar 20, 2019
e5f0b42
Merge branch 'master' into delete-swag-cli-section
pei0804 Mar 20, 2019
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
15 changes: 2 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,24 +51,13 @@ $ swag init

Make sure to import the generated `docs/docs.go` so that your specific configuration gets `init`'ed. If your General API annotations do not live in `main.go`, you can let swag know with `-g` flag.
```sh
swag init -g http/api.go
$ swag init -g http/api.go
```

## swag cli
You can see help.

```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: "./")
--propertyStrategy value, -p value Property Naming Strategy like snakecase,camelcase,pascalcase (default: "camelcase")
--output value, -o value Output directory for al the generated files(swagger.json, swagger.yaml and doc.go) (default: "./docs")
```

## Supported Web Frameworks
Expand Down