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

Fixed broken formatting in README.md #138

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fixed broken formatting in README.md #138

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ _This tool currently generates Swagger 1.x spec files -- there are plans to upda
|------------------|---------------------------|
| **-apiPackage** | Package with API controllers implementation |
| **-mainApiFile** | Main API file. This file is used for generating the "General API Info" bits. If `-mainApiFile` is not specified, then `$apiPackage/main.go` is assumed. |
| **-format** | One of: `go|swagger|asciidoc|markdown|confluence`. Default is `-format="go"`. See See [docs](https://github.com/yvasiyarov/swagger/wiki/Generate-Different-Formats). |
| **-format** | One of `go\|swagger\|asciidoc\|markdown\|confluence`. Default is `-format="go"`. See [docs](https://github.com/yvasiyarov/swagger/wiki/Generate-Different-Formats). |
| **-output** | Output specification. Default varies according to -format. See [docs](https://github.com/yvasiyarov/swagger/wiki/Generate-Different-Formats). |
| **controllerClass** | Speed up parsing by specifying which receiver objects have the controller methods. The default is to search all methods. The argument can be a regular expression. For example, `-controllerClass="(Context|Controller)$"` means the receiver name must end in Context or Controller. |
| **contentsTable** | Whether to generate Table of Contents; default: `true`. |
Expand All @@ -67,4 +67,4 @@ To run the generated swagger UI (assuming you used -format="go"), copy/move the

**Known Limitations** : [Read More](https://github.com/yvasiyarov/swagger/wiki/Known-Limitations)

**Generating Different Format Docs**: [Read More](https://github.com/yvasiyarov/swagger/wiki/Generate-Different-Formats)
**Generating Different Format Docs**: [Read More](https://github.com/yvasiyarov/swagger/wiki/Generate-Different-Formats)