Skip to content

tonydeng/api-blueprint-docker

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

33 Commits
 
 
 
 
 
 
 
 

Repository files navigation

API Blueprint Docker

Docker Stars Docker Pulls Image Size Image Layers

本Docker Image提供了三个服务。

  1. API Blueprint Document Server,基于Nginx Aglio
  2. API Blueprint Mock Server,基于Drakov
  3. API Blueprint Document Server和Mock Server在Docker容器内部更新的Webhook,基于Nodejs

获取镜像

docker pull wolfdeng/api-blueprint-docker

查看镜像详细信息 https://hub.docker.com/r/wolfdeng/api-blueprint-docker/

启动

指定API Blueprint文档Git公有仓库

docker run --name api-blueprint -e "repository={repository}" -p 80:80 -p 8080:8080 -p 3000:3000 -d wolfdeng/api-blueprint-docker

通过 -e "repository={repository}" 来指定仓库,具体使用时替换{repository}为正式仓库地址即可。

指定API Blueprint文档Git私有仓库

docker run --name api-blueprint-test -v ~/.ssh:/root/.ssh -e "repository={repository}" -p 80:80 -p 8080:8080 -p 3000:3000 -d wolfdeng/api-blueprint-docker

通过 -v ~/.ssh:/root/.ssh 来讲本地的private key映射到Docker容器中的ROOT账号

指定本地API Blueprint文档目录

docker run --name api-blueprint-test -v ${api-blueprint-path}:/opt/api-blueprint -p 80:80 -p 8080:8080 -p 3000:3000 -d wolfdeng/api-blueprint-docker

指定API Blueprint文档模板风格

docker run --name api-blueprint -e "aglio=--theme-template triple" -e "repository={repository}" -p 80:80 -p 8080:8080 -p 3000:3000 -d wolfdeng/api-blueprint-docker

通过 -e "aglio=--theme-template triple" 来指定aglio生成HTML的风格,比如现在指定的就是"triple"。更多aglio相应内容可以查看Aglio文档

使用Webhook

  • 可以简单使用CURL来进行Webhook调用
curl http://localhost:8080
  • 可以在Git托管服务上指定Webhook地址