一、API Umbrella 介绍
1.什么是API Umbrella ?
API Umbrella 是用于公开Web服务API的开源API管理平台。API Umbrella 的基本目标是使API创建者和API使用者的生活更加轻松。
2.api-umbrella提供两个视角
管理员:设定API映射
普通用户:注册系统账号获得API KEY,并使用API KEY调用API
3.按照两个视角试用
1)admin视角
--首先作为平台管理员添加一个REST API
--访问http://10.0.0.10/admin ip就是你安装机器的地址,初次登录会设定admin 账号
--配置API BackEnd 添加一个 API
--主要是设定url 映射,已经rate limit,是限定访问次数
--设定完API映射后,一定要publish API,否则不生效
2)user视角
--注册一个API User,就是API的消费者
--保留好API Key,请求的时候必须带着API KEY。这是用户注册后,能看到API KEY。请求的时候要带上。作为admin 在后台能看到所有用户的API_KEY
4.API Umbrella 的优点
1. 可以统计调用次数,便于计费
2. 可以限制调用频率,便于控制负载压力
二、API Umbrella安装
1.docker中安装
sudo mkdir config && sudo touch config/api-umbrella.yml
sudo docker run -d --name=api-umbrella -p 80:80 -p 443:443 -v "$(pwd)/config":/etc/api-umbrella nrel/api-umbrella
2.查看是否启动
sudo docker ps
3.访问
4.获取一个API Key
用户名:test
邮箱:123@163.com
密钥:0zWch3PCtGfSQPKSH6TuUOyGmTX0MVFPI1obrY3l
注意:Api key发给需要调用api的用户,调用接口时当参数进行传输。
5.访问登录
--首次访问登录是管理员界面
https://10.0.0.10/admin
三、Api-umbrella使用
1.admin视角
1)配置API BackEnd 添加一个 API
2)主要是设定url 映射,已经rate limit,是限定访问次数
3)设定完API映射后,一定要publish API,否则不生效