https://github.com/magic-peng/go-swagger-ui

Start the Swagger UI service with a simple command-line command.
https://github.com/magic-peng/go-swagger-ui

command-line-tool golang swagger swagger-ui

Last synced: 6 days ago
JSON representation

Start the Swagger UI service with a simple command-line command.

• Host: GitHub
• URL: https://github.com/magic-peng/go-swagger-ui
• Owner: magic-peng
• License: mit
• Created: 2024-10-12T02:17:44.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-10-22T05:06:57.000Z (4 months ago)
• Last Synced: 2024-12-07T03:08:50.953Z (2 months ago)
• Topics: command-line-tool, golang, swagger, swagger-ui
• Language: Go
• Homepage:
• Size: 2.38 MB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Swagger UI Project

This is a simple project that uses Golang to start Swagger UI.

## Multilingual Versions

- 🇨🇳 [简体中文](./README-cn.md)

## Open Source Projects Used

This project uses the following open source projects:

- [Swagger UI](https://github.com/swagger-api/swagger-ui): A powerful tool for generating and displaying API documentation. Swagger UI makes it easy for users to interact with APIs, view available endpoints, and see request and response examples.

Thanks to the Swagger UI team for their excellent work and contributions!

## Usage Steps

1. **Install**:

    ```bash

    go install github.com/magic-peng/go-swagger-ui

    ```

2. **Start the Server**:

    ```bash

    go-swagger-ui --swagger=./swagger.json --port=8080

    ```

3. **Access Swagger UI**:

   Open [http://localhost:8080](http://localhost:8080) in your browser to view the API documentation.

## License

This project is licensed under the MIT License.