slecache/api-console

Docker中的api:Console

一个Docker镜像，用于运行https://github.com/mulesoft/api-console，以展示基于RAML的REST API文档。

安装

从Docker Hub下载

bash
docker pull docker.xuanyuan.run/slecache/api-console

构建Docker镜像

bash
docker build -t slecache/api-console .

演示

点击以下按钮可启动2小时的免费演示服务器：

快速开始

如何使用此镜像

bash
docker run -p 9000:9000 -d docker.xuanyuan.run/slecache/api-console

然后在浏览器中通过http://localhost:9000访问。

如何部署你的API

你的主RAML文件必须命名为main.raml。

挂载本地卷

bash
docker run -v /你的本地RAML文件目录:/data/dist/apis --name DATA docker.xuanyuan.run/busybox true
docker run --volumes-from DATA -p 9000:9000 -p 35729:35729 -d docker.xuanyuan.run/slecache/api-console

注意：已激活实时重载功能。编辑本地目录中的任何文件都会触发浏览器中api:Console的自动重新加载。

构建自定义镜像

在包含main.raml的RAML文档根目录下，创建以下Dockerfile：

dockerfile
FROM docker.xuanyuan.run/slecache/api-console

然后运行构建命令：

bash
docker build -t 你的镜像名称 .

所有文档文件将被复制到Docker镜像的/data/dist/apis目录中。

用户反馈

问题反馈

如果对此镜像有任何问题或疑问，请通过https://github.com/slecache/api-console-docker/issues与我们联系。

贡献步骤

1. Fork本项目
2. 创建功能分支（git checkout -b my-new-feature）
3. 提交更改（git commit -am 'Add some feature'）
4. 推送到分支（git push origin my-new-feature）
5. 创建新的Pull Request