flexconstructor/go-swagger

docker-go-swagger

该镜像包含http://swagger.io/%E7%9A%84%E5%AE%9E%E7%8E%B0%EF%BC%8C%E8%83%BD%E5%A4%9F%E5%AF%B9Swagger%E8%A7%84%E8%8C%83%E8%BF%9B%E8%A1%8C%E5%BA%8F%E5%88%97%E5%8C%96%E5%92%8C%E5%8F%8D%E5%BA%8F%E5%88%97%E5%8C%96%E6%93%8D%E4%BD%9C%E3%80%82%E6%9C%AC%E9%95%9C%E5%83%8F%E5%9F%BA%E4%BA%8Ehttps://github.com/go-swagger/go-swagger%E9%A1%B9%E7%9B%AE%E6%9E%84%E5%BB%BA%EF%BC%8C%E8%A7%A3%E5%86%B3%E4%BA%86%E5%AE%98%E6%96%B9%E9%95%9C%E5%83%8F%E7%BC%BA%E5%B0%91gcc%E7%9A%84%E9%97%AE%E9%A2%98%E3%80%82

核心功能

• 生成Swagger规范文件（swagger.json）
• 运行Swagger UI展示API文档
• 支持Swagger 2.0规范的序列化与反序列化

使用场景

• 开发API时自动生成Swagger文档规范
• 本地运行Swagger UI预览API文档

配置说明与使用步骤

1. 在API源代码中添加Swagger注释（参考swagger.json生成指南）。
2. 生成swagger.json文件：

bash
$ docker run --rm \
    -v "本地项目路径":/go/src/your/project \
    -w /go/src/your/project \
    flexconstructor/go-swagger generate spec \
    -o /go/src/your/project/swagger.json

3. 运行Swagger UI：

bash
$ docker run \
    -v "本地项目路径":/go/src/your/project \
    -w /go/src/your/project \
    -p [本地端口:容器端口] \
    flexconstructor/go-swagger swagger serve ./swagger.json \
    --flavor=swagger \
    --port=[容器端口]

镜像构建与测试

• 构建镜像：

bash
$ make image

• 测试镜像：

bash
$ make test