edfialliance/ods-api-swaggerui

Ed-Fi Web SwaggerUI

提供SwaggerUI的Docker部署方案，专为Ed-Fi ODS/API设计优化，用于接口文档的可视化与交互。

注意
此镜像不推荐用于生产环境。

镜像概述

该镜像基于Alpine系统构建，提供轻量级的SwaggerUI部署，旨在简化Ed-Fi ODS/API接口文档的访问与测试流程。通过容器化方式，可快速搭建接口文档服务，支持环境变量配置以适应不同使用场景。

镜像变体

目前唯一支持的镜像版本为基于Alpine的实现，镜像标签格式如下：
edfialliance/ods-api-swaggerui:<version>
（其中<version>需替换为具体版本号）

支持的环境变量

使用方法

基本部署

1. 拉取镜像：

   bash
   docker pull edfialliance/ods-api-swaggerui:<version>
   

2. 运行容器（示例）：

   bash
   docker run -d -p 8080:8080 \
     -e SAMPLE_KEY="your-template-key" \
     -e SAMPLE_SECRET="your-template-secret" \
     --name edfi-swaggerui \
     edfialliance/ods-api-swaggerui:<version>
   

3. 访问SwaggerUI：
   打开浏览器访问 http://localhost:8080 即可查看接口文档。

相关文档

• https://github.com/Ed-Fi-Alliance-OSS/Ed-Fi-ODS/blob/main/CODE_OF_CONDUCT.md
• https://github.com/Ed-Fi-Alliance-OSS/Project-Tanager/blob/main/CONTRIBUTING.md
• https://github.com/Ed-Fi-Alliance-OSS/Ed-Fi-ODS/blob/main/CONTRIBUTORS.md
• https://github.com/Ed-Fi-Alliance-OSS/Ed-Fi-ODS/blob/main/NOTICES.md
• https://github.com/Ed-Fi-Alliance-OSS/Ed-Fi-ODS/blob/main/SECURITY.md
• https://github.com/Ed-Fi-Alliance-OSS/Ed-Fi-ODS/blob/main/LICENSE

***信息

版权所有 (c) 2024 Ed-Fi Alliance, LLC 及贡献者。

本软件基于 Apache License, Version 2.0（以下简称“许可证”）授权。

除非适用***要求或书面同意，否则根据许可证分发的软件按“原样”提供，不附带任何明示或暗示的担保或条件。有关许可证下的权限和限制详情，请参阅许可证文本。

Docker基础镜像说明

与所有Docker镜像一样，本镜像可能包含其他软件，这些软件可能受其他许可证约束（例如基础发行版中的Bash等，以及包含的主要软件的任何直接或间接依赖项）。

对于任何预构建镜像的使用，镜像用户有责任确保对本镜像的任何使用符合其中包含的所有软件的相关许可证要求。