Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/moajs/koa.res.api
koa.res.api is a koa middleware for render json api , it convention over api format
https://github.com/moajs/koa.res.api
Last synced: about 16 hours ago
JSON representation
koa.res.api is a koa middleware for render json api , it convention over api format
- Host: GitHub
- URL: https://github.com/moajs/koa.res.api
- Owner: moajs
- License: mit
- Created: 2015-06-19T11:07:59.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2021-03-31T06:35:18.000Z (over 3 years ago)
- Last Synced: 2024-09-19T16:08:55.168Z (about 2 months ago)
- Language: JavaScript
- Homepage: https://github.com/moajs/koa.res.api
- Size: 11.7 KB
- Stars: 20
- Watchers: 6
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# koa.res.api
[](http://badge.fury.io/js/koa.res.api)
koa.res.api is a koajs middleware for render json api , it convention over api format like this :
{
data: {
},
status: {
code : x,
msg : 'some message'
}
}
more see at
- [客户端 API 开发总结](https://cnodejs.org/topic/552b3b9382388cec50cf6d95)
- [res.api on express](https://github.com/moajs/res.api)
## Install
for koa2
npm install --save koa.res.api
如果是koa1
npm install --save koa.res.api@1
## Usages
var koa = require('koa');
var app = koa();
var res_api = require('koa.res.api');
app.use(res_api());
then in some route
### way 1：最通用的api接口
this.api(404 , err, {
code : 1,
msg : 'delete failed!'
});
the response header is :
HTTP/1.1 404 Not Found
X-Powered-By: Express
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST
Access-Control-Allow-Headers: X-Requested-With,content-type, Authorization
Content-Type: application/json; charset=utf-8
Content-Length: 239
ETag: W/"ef-6e66e2da"
set-cookie: connect.sid=s%3ApwL-xMS2tCh3qgqp_wyIqukbUKFeJv6S.2EB4449yTlxRWZrRyBXRc9J6Pv%2BNz4M7j35VLIlxE6M; Path=/; Expires=Wed, 17 Jun 2015 15:11:28 GMT; HttpOnly
Date: Wed, 17 Jun 2015 14:41:28 GMT
Connection: keep-alive
response json data
{
"data": {
"message": "Cast to ObjectId failed for value \"557a3e326221681d474cf078sdsds\" at path \"_id\"",
"name": "CastError",
"kind": "ObjectId",
"value": "557a3e326221681d474cf078sdsds",
"path": "_id"
},
"status": {
"code": 1,
"msg": "delete failed!"
}
}
### way 2：返回成功带有状态的json数据
this.api(data, {
code : 1,
msg : 'delete failed!'
});
the response header is :
HTTP/1.1 200 Ok
X-Powered-By: Express
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST
Access-Control-Allow-Headers: X-Requested-With,content-type, Authorization
Content-Type: application/json; charset=utf-8
Content-Length: 239
ETag: W/"ef-6e66e2da"
set-cookie: connect.sid=s%3ApwL-xMS2tCh3qgqp_wyIqukbUKFeJv6S.2EB4449yTlxRWZrRyBXRc9J6Pv%2BNz4M7j35VLIlxE6M; Path=/; Expires=Wed, 17 Jun 2015 15:11:28 GMT; HttpOnly
Date: Wed, 17 Jun 2015 14:41:28 GMT
Connection: keep-alive
response json data
{
"data": {
"message": "Cast to ObjectId failed for value \"557a3e326221681d474cf078sdsds\" at path \"_id\"",
"name": "CastError",
"kind": "ObjectId",
"value": "557a3e326221681d474cf078sdsds",
"path": "_id"
},
"status": {
"code": 1,
"msg": "delete failed!"
}
}
### way 3：最常用的成功返回json数据
this.api(data);
the response header is :
HTTP/1.1 200 Ok
X-Powered-By: Express
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST
Access-Control-Allow-Headers: X-Requested-With,content-type, Authorization
Content-Type: application/json; charset=utf-8
Content-Length: 239
ETag: W/"ef-6e66e2da"
set-cookie: connect.sid=s%3ApwL-xMS2tCh3qgqp_wyIqukbUKFeJv6S.2EB4449yTlxRWZrRyBXRc9J6Pv%2BNz4M7j35VLIlxE6M; Path=/; Expires=Wed, 17 Jun 2015 15:11:28 GMT; HttpOnly
Date: Wed, 17 Jun 2015 14:41:28 GMT
Connection: keep-alive
response json data
{
"data": {
"message": "Cast to ObjectId failed for value \"557a3e326221681d474cf078sdsds\" at path \"_id\"",
"name": "CastError",
"kind": "ObjectId",
"value": "557a3e326221681d474cf078sdsds",
"path": "_id"
},
"status": {
"code": 0,
"msg": "request success!"
}
}
### way 4：快捷错误处理
this.api_error(err);
the response header is :
HTTP/1.1 200 Ok
X-Powered-By: Express
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST
Access-Control-Allow-Headers: X-Requested-With,content-type, Authorization
Content-Type: application/json; charset=utf-8
Content-Length: 239
ETag: W/"ef-6e66e2da"
set-cookie: connect.sid=s%3ApwL-xMS2tCh3qgqp_wyIqukbUKFeJv6S.2EB4449yTlxRWZrRyBXRc9J6Pv%2BNz4M7j35VLIlxE6M; Path=/; Expires=Wed, 17 Jun 2015 15:11:28 GMT; HttpOnly
Date: Wed, 17 Jun 2015 14:41:28 GMT
Connection: keep-alive
response json data
{
"data": {
"message": "Cast to ObjectId failed for value \"557a3e326221681d474cf078sdsds\" at path \"_id\"",
"name": "CastError",
"kind": "ObjectId",
"value": "557a3e326221681d474cf078sdsds",
"path": "_id"
},
"status": {
"code": -1,
"msg": "api error"
}
}
## jsonp support
```
const Koa = require('koa');
const app = new Koa();
const api = require('./index');
const jsonp = require('koa-jsonp')
app.use(api());
app.use(jsonp())
app.use(function (ctx, next){
ctx.is_jsonp = true;
var data = {
a:1,
b:2
}
ctx.api_error(data);
});
```
Note:
- `ctx.is_jsonp = true;`
- require `koa-jsonp`
## video
给res.api录了一段7分钟的视频(res.api和koa.res.api是一样，只是res.api是基于express)：
http://pan.baidu.com/s/1eQo4xqi
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
## Version History
- v1.0.11 支持自定义api_error信息
- v1.0.0 初始化版本
## 欢迎fork和反馈
- write by `i5ting` [email protected]
如有建议或意见，请在issue提问或邮件
## License
this repo is released under the [MIT
License](http://www.opensource.org/licenses/MIT).