企业级API管理平台实践

2019年8月22日18:14:01 2 594 views

前言

随着API数量越来越多,wiki已经再也体现不出它的优势了。冗长的文档资料让人难以维护,稍微一点小改动就需要对很多地方进行修改。以前见到过的解决方案是,使用Confluence来进行接口管理和测试。但最近一位前端大佬推荐了YAPI这套API集成管理平台,上手后发现还挺不错的,不过也有一些不方便的地方,看完后可以根据需求选择。

今天为大家介绍2款不错的管理工具
Yapi
ShowDoc

环境:

centos 7
1C 2G
docker 18.09.7

Docker安装教程

一、YAPI 简介

企业级API管理平台实践

YAPI是去哪儿网团队YMFE开发的一个开源项目,用于API开发,帮助开发者轻松创建、发布、维护 API,协议Apache 2.0,非常良心,目前主要给我们测试部门使用。

YAPI——高效、易用、功能强大的API管理平台,旨在为开发、产品、测试人员提供更优雅的接口管理服务。

主要功能模块

企业级API管理平台实践

二、Docker快速部署Yapi

无论你是什么安装方式,都要满足如下 三点:
企业级API管理平台实践

1、创建 MongoDB 数据卷

docker volume create mongo_data_yapi

2、启动 MongoDB

docker run -d --name mongo-yapi -v mongo_data_yapi:/data/db mongo

3、获取 Yapi 镜像

docker pull registry.cn-hangzhou.aliyuncs.com/anoy/yapi

版本信息可在 阿里云镜像仓库查看,目前最新版本如下图:
企业级API管理平台实践

4、初始化 Yapi

初始化数据库索引及管理员账号

docker run -it --rm \
  --link mongo-yapi:mongo \
  --entrypoint npm \
  --workdir /api/vendors \
  registry.cn-hangzhou.aliyuncs.com/anoy/yapi \
  run install-server

如果你需要定制化,参考官方config.json,【本文中未使用】

5、启动 Yapi 服务

docker run -d \
  --name yapi \
  --link mongo-yapi:mongo \
  --workdir /api/vendors \
  -p 3000:3000 \
  registry.cn-hangzhou.aliyuncs.com/anoy/yapi \
  server/app.js
## --link 简单来说就是 用来链接2个容器,使mongo-yapi与 yapi可以互相通信。

企业级API管理平台实践

6、登录验证 Yapi

访问 http://localhost:3000 登录账号 admin@admin.com,密码 ymfe.org

企业级API管理平台实践

Yapi官网使用教程

二、ShowDoc

ShowDoc是一个非常适合IT团队的在线API文档、技术文档工具。你可以使用Showdoc来编写在线API文档、技术文档、数据字典、在线手册。

官方地址:https://www.showdoc.cc/

3.1 获取镜像

docker pull xd2idwf5.mirror.aliyuncs.com/star7th/showdoc
docker tag xd2idwf5.mirror.aliyuncs.com/star7th/showdoc:latest star7th/showdoc:latest   #使用中国大陆镜像,下载后可以tar以进行重命名,方便后面使用)

3.2 数据持久化

mkdir /showdoc_data
mkdir /showdoc_data/html
chmod 777 -R /showdoc_data

3.3 启动showdoc容器。

启动完了后别忘记后面还有转移数据的步骤。

docker run -d --name showdoc -p 4999:80 -v /showdoc_data/html:/var/www/html/      star7th/showdoc

3.4 转移数据

转移数据。执行这里的时候留意命令行界面有没有权限禁止的错误提示。
如果有,则检查权限,或者安全限制(比如说可能selinux会禁止docker进程写文件)

docker exec showdoc \cp -fr /showdoc_data/html/ /var/www/
# 权限
chmod -R 777  /showdoc_data

showdoc相关信息:

showdoc 数据存储目录: `/showdoc_data/html`
showdoc 访问路径:`http://localhost:4999` 账户密码是`showdoc/123456`

对showdoc的问题或建议请加入我们《逗哥Linux精英学习交流》,一起讨论学习。。。

登录测试

企业级API管理平台实践
企业级API管理平台实践
企业级API管理平台实践
企业级API管理平台实践
企业级API管理平台实践
企业级API管理平台实践

ok,到这里,一个api文档就完成了。

showdoc 有1点不足:

问题:开发要测试这个接口怎么办???

打开postman,输入上面的请求url,选择POST请求,输入参数.....
是不是很麻烦?还得让开发安装postman,进行一系列操作。

那么有没有直接在这个网页上,集成postman功能,可以直接发送POST请求,查看返回结果呢?

有,那就是上面介绍的YApi,孰轻孰重您自己看着来。。。。

  • QQ精品交流群
  • weinxin
  • 微信公众号
  • weinxin
admin

发表评论

:?: :razz: :sad: :evil: :!: :smile: :oops: :grin: :eek: :shock: :???: :cool: :lol: :mad: :twisted: :roll: :wink: :idea: :arrow: :neutral: :cry: :mrgreen:

目前评论:2   其中:访客  1   博主  1

    • avatar 请输入您的QQ号 0

      哈哈厉害了