gianmarcosanti/santi-manager-api-gateway

Swagger生成的服务器

镜像概述

该镜像包含由https://github.com/swagger-api/swagger-codegen%E9%A1%B9%E7%9B%AE%E7%94%9F%E6%88%90%E7%9A%84%E6%9C%8D%E5%8A%A1%E5%99%A8stub%EF%BC%8C%E5%9F%BA%E4%BA%8EOpenAPI%E8%A7%84%E8%8C%83%E6%9E%84%E5%BB%BA%EF%BC%8C%E4%BD%BF%E7%94%A8Connexion%E5%BA%93%E5%A2%9E%E5%BC%BAFlask%E6%A1%86%E6%9E%B6%E5%8A%9F%E8%83%BD%EF%BC%8C%E5%AE%9E%E7%8E%B0Swagger%E5%90%AF%E7%94%A8%E7%9A%84API%E6%9C%8D%E5%8A%A1%E5%99%A8%E3%80%82%E4%B8%BB%E8%A6%81%E7%94%A8%E9%80%94%E6%98%AF%E5%BF%AB%E9%80%9F%E6%90%AD%E5%BB%BA%E7%AC%A6%E5%90%88OpenAPI%E6%A0%87%E5%87%86%E7%9A%84API%E6%9C%8D%E5%8A%A1%E5%8E%9F%E5%9E%8B%EF%BC%8C%E6%8F%90%E4%BE%9B%E8%87%AA%E5%8A%A8%E7%94%9F%E6%88%90%E7%9A%84API%E6%96%87%E6%A1%A3%E5%92%8C%E4%BA%A4%E4%BA%92%E6%B5%8B%E8%AF%95%E7%95%8C%E9%9D%A2%E3%80%82

核心功能与特性

• OpenAPI规范支持：基于远程或本地OpenAPI规范文件生成服务器代码
• Connexion集成：在Flask基础上提供自动请求验证、路由处理和API文档生成
• Swagger UI界面：内置交互式API测试界面，支持在线调试API
• 标准化文档：自动生成swagger.json规范文件，便于API文档管理
• 测试支持：集成tox工具，支持自动化集成测试

使用场景

• API开发初期的服务器原型搭建
• 快速验证OpenAPI规范的可行性
• 为前端开发提供API模拟服务
• API文档生成与测试环境构建

环境要求

• Python 3.5.2或更高版本（本地运行时）
• Docker环境（容器化部署时）

使用方法

本地运行

1. 安装依赖包：

   bash
   pip3 install -r requirements.txt
   

2. 启动服务器：

   bash
   python3 -m swagger_server
   

3. 访问Swagger UI界面：

   http://localhost:8080/ui/
   

4. 查看Swagger规范文件：

   http://localhost:8080/swagger.json
   

5. 运行集成测试：

   bash
   # 安装tox
   sudo pip install tox
   # 执行测试
   tox
   

Docker容器运行

构建镜像

bash
docker build -t swagger_server .

启动容器

bash
docker run -p 8080:8080 docker.xuanyuan.run/swagger_server

容器启动后，可通过http://localhost:8080/ui/访问Swagger UI界面，通过http://localhost:8080/swagger.json获取API规范文件。