https://github.com/funnyang/swagger-ui-simple

一个简单的本地 swagger-ui 服务器
https://github.com/funnyang/swagger-ui-simple

Last synced: 2 months ago
JSON representation

一个简单的本地 swagger-ui 服务器

• Host: GitHub
• URL: https://github.com/funnyang/swagger-ui-simple
• Owner: Funnyang
• Created: 2019-03-30T17:01:27.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2019-03-30T17:14:15.000Z (about 6 years ago)
• Last Synced: 2025-02-08T03:41:24.170Z (4 months ago)
• Language: Go
• Homepage:
• Size: 8.52 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Swagger-ui-simple

一个简单的小工具，用来方便查看本地 swagger api 文档。

本地编写的 `yaml` 文件通常不方便查看，所以做了这个小工具。简单集成了 `swagger-ui`，使用 `Go` 语言编写，鉴于 `Go` 优势将静态文件打包进了一个文件，真正的简单易用。

把编译后的 `swagger-ui` 复制到环境路径下，就可以在任意目录调用它了。

## 使用方法

以当前目录为根目录

```

./swagger-ui

```

指定文件根目录

```

./swagger-ui docs

```

浏览器打开 http://localhost:8080 即可查看文档，默认查看本地的 index.yaml 文件

## 编译

### 安装依赖

```

go get -u github.com/mjibson/esc

```

### 编译运行

```

bash build.sh

```

编译完毕之后，会自动运行程序

## 更新 swagger-ui

执行一下脚本后重新编译即可

```

bash update-swagger-ui.sh

```