satori/kana

Fork 0

satori 124f564b29 bash

2021-11-29 14:06:07 +08:00

5.4 KiB

Raw Blame History

かな

Nodejs 构建的 RESTful 风格 WEB API

抽象化以扩大泛用性, 适用于各种形态的项目
无须配置依赖项的, 使用内嵌数据库
单文件, 代码不到 300 行, 易于维护, 易于扩展

由于使用已被大量实践的协议与风格建议, 文档中不再讲解此类细节, 这里将假设你已经了解:

RESTful 风格 URL
HTTP Method 资源操作方式

Install

# clone 到本地
git clone https://github.com/InvisibleFuture/kana.git

# 切换到项目目录
cd kana

# 使用 yarn 或 npm 安装依赖包
yarn

# 使用 node 运行 index 文件
node index

# 也可以使用 pm2 作守护进程
pm2 start node --name kana -- index

特征

/:name/:_id

RESTful 风格 API, URL形式为两段 name是对象类型, _id是对象id

如发表一篇文章,

使用示例

创建用户

当程序在本地运行时, localhost:2333

fetch('/user', {
    method: 'POST',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify({
        name: 'Kana',
        password: '00000000'
    }),
}).then(Response => Response.json()).then(data => {
  console.log(data)
})

// 返回账户信息
{
    _id: 'ApSXNLoUy',
    name: 'Kana',
    avatar: 'https://xxxx.xxx/xxx.png'
}

创建的第一个账户默认为管理员
可以使用管理员权限设置其他账户为管理员
默认并没有验证邮箱等检查步骤, 允许直接设置, 也允许用户重名

修改资料

fetch('/user/ApSXNLoUy', {
    method: 'PATCH',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify({
        name: 'Hana',
        password: '11111111'
    }),
}).then(Response => Response.json()).then(data => {
  console.log(data)
})

PATCH 时, 只发送要修改的字段(例如不需要修改用户名时, 发送的json不带name字段)

上传头像

<!DOCTYPE html>
<input type="file" name="photos", multiple, onchange="upload()"/>

<script>
function upload() {
    let myForm = new FormData();
    let files = document.querySelector("[type=file]").files;
    files.map(item => myForm.append("photos", item))
    fetch('/user/ApSXNLoUy', {
        method: 'POST',
        headers: { 'Content-Type': 'multipart/form-data'},
        body: myForm
    }).then(Response => Response.json()).then(data => {
        console.log(data)
    })
}
</script>

fetch('/user/ApSXNLoUy', {
    method: 'PATCH',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify({
        avatar: '/xxxx.jpg'
    }),
}).then(Response => Response.json()).then(data => {
  console.log(data)
})

删除用户

fetch('/user/ApSXNLoUy', {
    method: 'DELETE',
}).then(Response => Response.json()).then(data => {
  console.log(data)
})

创建文章

fetch('/book', {
    method: 'POST',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify({
        name: 'Kana na na na',
        data: 'xx x xx xx xxx xx'
    }),
}).then(Response => Response.json()).then(data => {
  console.log(data)
})

// 返回文章信息
{
    _id: 'ppNXLoUK',
    name: 'Kana na na na',
    data: 'xx x xx xx xxx xx'
}

评论文章

fetch('/post?attach=book&aid=ppNXLoUK', {
    method: 'POST',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify({
        data: 'ahahahha~'
    }),
}).then(Response => Response.json()).then(data => {
  console.log(data)
})

{
    _id: 'spNkjLA',
    data: 'ahahahha~'
}

点赞评论

fetch('/like?attach=post&aid=spNkjLA', {
    method: 'POST',
}).then(Response => Response.json()).then(data => {
  console.log(data)
})

{
    _id: 'SOAPSAdaw'
}

取消点赞

fetch('/like/SOAPSAdaw', {
    method: 'DELETE',
}).then(Response => Response.json()).then(data => {
  console.log(data)
})

对象列表

GET /:name

{
    page: Number,     // 当前页码(默认为1)
    pagesize: Number, // 分页大小(默认20)
	sort: string,     // 排序方式(只能是对象的通用属性名)
	desc: Number,     // 0或1, 正序和倒序
	uid: string,      // 指定发布者uid查询
	like: bool,       // 查询自己点赞了的对象
	post: bool,       // 查询自己评论过的对象
	count: bool,      // 计数器(在返回的headers中附带列表统计信息)
}

除以上通用属性外, 对象的私有属性也可以用于查询
如果查询参数包含了不存在的参数, 将返回 400 错误
查询列表时, 相同的查询条件有15s缓存
如果查询公共的列表, 只返回状态为 pubilc的
如果查询自己的列表, 则同时返回私有状态的

查询示例:

fetch('/book').then(Response => Response.json()).then(data => {
  console.log(data)
})

// 返回结果
[
    {_id:'xxx', data:'xxxx'},
    {_id:'xxx', data:'xxxx'}
]

创建示例:

fetc('/book', {
    method: 'POST',
    headers: {
        'Accept': 'application/json',
        'Content-Type': 'application/json',
    },
    body: JSON.stringify({
        name: '创建一本新书',
        data: '书的内容'
    }),
}).then(Response => Response.json()).then(data => {
  console.log(data)
})

// 返回结果
{
    _id: 'xxx',
    uid: 'xxx',
    name: '创建一本新书',
    data: '书的内容'
}

5.4 KiB Raw Blame History

かな