https://github.com/utahta/swagger-doc

Easy visualize swagger.json using swagger-ui and redoc
https://github.com/utahta/swagger-doc

document go swagger

Last synced: 2 months ago
JSON representation

Easy visualize swagger.json using swagger-ui and redoc

• Host: GitHub
• URL: https://github.com/utahta/swagger-doc
• Owner: utahta
• Created: 2017-02-26T09:17:51.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2017-02-26T09:33:34.000Z (almost 8 years ago)
• Last Synced: 2024-11-04T18:45:35.742Z (3 months ago)
• Topics: document, go, swagger
• Language: Go
• Homepage:
• Size: 1.39 MB
• Stars: 5
• Watchers: 4
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-ccamel - utahta/swagger-doc - Easy visualize swagger.json using swagger-ui and redoc (Go)

README

        
# swagger-doc

swagger-doc is tool of easy visualize your swagger.json using swagger-ui and redoc.

## Install

```bash

go get -u github.com/utahta/swagger-doc/cmd/swagger-doc

```

## Usage

### Local file

```bash

swagger-doc -s /path/to/swagger.json

```

then open browser.

### URL

```bash

swagger-doc -s http://localhost/swagger.json

```

then open browser.

## Contributing

1. Fork it ( https://github.com/utahta/swagger-doc/fork )

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create a new Pull Request