adonis-rest

基于AdonisJs的Restful API基础构件， AdonisJs中文网： https://adonis-china.org

https://github.com/wxs77577/a...

安装

cnpm install --save adonis-rest

准备

Tips: 请确保你的/app/Model/目录里有一些模型文件. 如果没有的话可以用 ./ace make:model News 来创建一个新闻模型

/app/Http/routes.js

Route.put('/api/:resource', 'RestController.update') //可选
Route.resource('/api/:resource', 'RestController')

Create /app/Http/Controllers/RestController.js

'use strict'const BaseRestController = require('adonis-rest')class RestController  extends BaseRestController{}module.exports = RestController

就这样，所有模型的Restful接口就可以访问了。

文档

Base uri: http://localhost:3333/api

请求方法	URL	描述
GET	/news	获取新闻列表
POST	/news	获取一条新闻
PUT/PATCH	/news/:id	修改一条新闻
DELETE	/news/:id	删除一条新闻

GET `/news`

获取所有新闻

URL查询参数

参数名	示例值	描述
pagination	1	获取包含分页信息的数据，否则获取扁平数组，不过你仍然可以通过`headers`来获取分页信息
query	{"user_id": 1}	查询条件，也可以用 `filter` 或 `where`
page	1	当前页
perPage	10	每页显示数量，也可以用 `limit`
offset	10	跳过数量，也可以用 `skip`
fields	id,title,created_at	`select`的字段
orderBy	id	排序，可以用`-id`表示`desc`（降序）

Headers中的分页信息字段

X-Pagination-Total-Count
X-Pagination-Page-Count
X-Pagination-Current-Page
X-Pagination-Per-Page

`query`字段的格式

query={"created_at": "2017-07-07"}
query={"created_at": [">", "2017-07-07"]} 或 <,<> 等等
query={"created_at": ["between", ["2017-07-01", "2017-07-31"]]} 或 notBetween
query={"user_id": ["in", [1,2,3] ]} 或 notIn
query={"user_id": ["raw", 'user_id IS NULL' ]}

有问题?

在Issues里面告诉我

adonis-rest - 基于AdonisJs的Restful API基础构件相关推荐

Yii2.0 RESTful API 之版本控制
Yii2.0 RESTful API 之版本控制之前我写过两篇关于 Yii2.0 RESTful API 如何搭建,以及认证等处理,但是没有涉及到版本管理,今天就来谈谈版本管理如何实现. 索性就 ...
RESTful API设计简介
1.什么是REST REST全称是Representational State Transfer,中文意思是表述性状态转移. 它首次出现在2000年Roy Fielding的博士论文中,Roy Fie ...
WebService为什么不如RESTful API流行
1 WebService有很多协议,为什么HTTP比较流行? WebService是个很重型的规范,它的应用协议是SOAP(简单对象访问协议),它所依赖的下层通信方式不单单是HTTP,也有SOAP o ...
RESTful API介绍
什么是RESTful REST与技术无关,代表的是一种软件架构风格,REST是Representational State Transfer的简称,中文翻译为"表征状态转移"或&q ...
php slim 教程,Slim - 超轻量级PHP Restful API构建框架
下载源码包: http://www.slimframework.com/ 基于Slim的Restful API Sample: require '/darjuan/Slim/Slim.php'; us ...
as 不显示gradle视图_Python构建RESTful网络服务[Django篇：基于类视图的API]
系列文章介绍本系列文章将详细介绍将Django官方引导教程中的投票项目改写为RESTful网络服务.Django官方教程地址https://docs.djangoproject.com/zh-han ...
restful api上传文件（基础）-springboot
restful api上传文件(基础)-springboot 基于restful api格式的文件上传(只是上传到本地): package com.nxz.controller;import com. ...
通过亚马逊云科技实现基于 Restful API 的 CloudFront Distribution 复制/克隆功能
背景 Amazon CloudFront 是一个全球性的内容分发网络 (CDN),您可以借助 CloudFront 以低延迟和高可用性向查看者或者最终用户分发内容.通常来讲,Amazon CloudF ...
启动服务错误5拒绝访问_【Go API 开发实战 5】基础1：启动一个最简单的 RESTful API 服务器...
启动一个最简单的 RESTful API 服务器本节核心内容启动一个最简单的 RESTful API 服务器设置 HTTP Header API 服务器健康检查和状态查询编译并测试 API 本 ...

adonis-rest - 基于AdonisJs的Restful API基础构件

adonis-rest

https://github.com/wxs77577/a...

安装

准备

文档

GET `/news`

URL查询参数

Headers中的分页信息字段

`query`字段的格式

有问题?

adonis-rest - 基于AdonisJs的Restful API基础构件相关推荐

最新文章

热门文章

adonis-rest - 基于AdonisJs的Restful API基础构件

adonis-rest

https://github.com/wxs77577/a...

安装

准备

文档

GET /news

URL查询参数

Headers中的分页信息字段

query字段的格式

有问题?

adonis-rest - 基于AdonisJs的Restful API基础构件相关推荐

最新文章

热门文章

GET `/news`

`query`字段的格式