API 非功能性需求
Schema - 规范
- HTTPS - 保护数据安全
- 数据格式 - Json
- 空字段以null返回
- 日期以ISO 8601返回?
- 编码以UTF-8 返回
- 未授权请求以404返回,以避免leak of information
- 错误输入(错误json格式),返回200,但是包含错误代码。
- 请求中支持的http header: content negotiation?api version?timezone?
Security - 安全
- 第三方应用注册,审核??
- 租户里设置访问权限,授权范围: 租户,项目
- 获取Oauth token
- 使用Oauth token访问service
Rate limits
- 每个应用应设定每小时最多访问次数。
- 不同级别的应用程序有不同的上限。
- 不同的API可以设置系统级的访问次数限制。
- 如果超越了rate limit会收到错误消息
Error handling
- 错误消息 HTTP200 + json message(code+message)
Logging
- 访问log,应包括应用和租户信息
Versioning
- Resource URI应该一直可用,当前版本URL中无需version参数
分类: web
标签:
搜索
标签
study
ab
amap
apache
apahe
awk
aws
bat
centos
CFS
chrome
cmd
cnpm
composer
consul
crontab
css
curl
cygwin
devops
di
docker
docker,docker-compose
ethereum
excel
fiddler
fluentd
framework
front-end
git
gitgui
github
glide
go
golang
gorm
grafana
gzip
ioc
item2
iterm2
javascript
jenkins
jsonp
kafka
laradock
laravel
larval
linux
liunux
log
mac
mac, wi-fi
macos
magento
mariaDB
minikube
mongoDB
msp
mysql
netbeans
nginx
nodejs
nohup
npm
nsq
php
php-fpm
php7
phpstorm
php扩展
Protobuf
python
redis
scp
server
shell
soap
socket
socket5
sql
sre
ssdb
ssh
ssl
study
sublime
swift
system
td-agent
uml
v2ray
vagrant
vagrnat
vim
vpn
vue
vue.js
webpack
webrtc
websocket
webtatic
windows
windows7
word
wps
xdebug
yarn
yii2
yum
zookeeper
世界国家
互联网
以太坊
分类
前端
小程序
打印机
排序算法
搞笑
权限
粤语
缓存
网络
虚拟机
视频
设计模式
项目管理
热门文章
友情链接