kylezhi / answer-api Goto Github PK

create database if not exists answer;

use answer;

create table user(
	id int unsigned not null auto_increment,
	username varchar(50) not null comment '用户名',
	password varchar(50) not null comment '密码',
	email varchar(50) not null comment '邮箱',
	avatar varchar(150) null comment '头像',
	gender bit null comment '性别',
	create_time datetime not null comment '创建时间',
	modify_time datetime not null comment '修改时间',
	primary key(id)
)engine=InnoDB charset=utf8 comment '用户表'; 

create table topics(
	id int unsigned not null auto_increment,
	title varchar(100) not null comment '标题',
	content text not null comment '内容',
	create_time datetime not null comment '创建时间',
	modify_time datetime not null comment '修改时间',
	user_id int unsigned not null comment '所属用户',
	primary key(id)
)engine=InnoDB charset=utf8 comment '话题表'; 

create table comments(
	id int unsigned not null auto_increment,
	content text not null comment '评论内容',
	create_time datetime not null comment '创建时间',
	modify_time datetime not null comment '修改时间',
	topics_id int unsigned not null comment '所属话题',
	user_id int unsigned not null comment '所属用户',
	reply_id int unsigned null comment '所属回复人',
	primary key(id)
)engine=InnoDB charset=utf8 comment '评论表'; 

|--- app.js
|--- config.js
|--- controllers
|--- models
|--- node_modules
|--- package.json
|--- package-lock.json
|--- routes

https://api.example.com/v1/zoos
https://api.example.com/v1/animals
https://api.example.com/v1/employees

GET /zoos：列出所有动物园
POST /zoos：新建一个动物园
GET /zoos/ID：获取某个指定动物园的信息
PUT /zoos/ID：更新某个指定动物园的信息（提供该动物园的全部信息）
PATCH /zoos/ID：更新某个指定动物园的信息（提供该动物园的部分信息）
DELETE /zoos/ID：删除某个动物园
GET /zoos/ID/animals：列出某个指定动物园的所有动物
DELETE /zoos/ID/animals/ID：删除某个指定动物园的指定动物

?limit=10：指定返回记录的数量
?offset=10：指定返回记录的开始位置。
?page=2&per_page=100：指定第几页，以及每页的记录数。
?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序。
?animal_type_id=1：指定筛选条件

200 OK - [GET]：服务器成功返回用户请求的数据，该操作是幂等的（Idempotent）。
201 CREATED - [POST/PUT/PATCH]：用户新建或修改数据成功。
202 Accepted - [*]：表示一个请求已经进入后台排队（异步任务）
204 NO CONTENT - [DELETE]：用户删除数据成功。
400 INVALID REQUEST - [POST/PUT/PATCH]：用户发出的请求有错误，服务器没有进行新建或修改数据的操作，该操作是幂等的。
401 Unauthorized - [*]：表示用户没有权限（令牌、用户名、密码错误）。
403 Forbidden - [*] 表示用户得到授权（与401错误相对），但是访问是被禁止的。
404 NOT FOUND - [*]：用户发出的请求针对的是不存在的记录，服务器没有进行操作，该操作是幂等的。
406 Not Acceptable - [GET]：用户请求的格式不可得（比如用户请求JSON格式，但是只有XML格式）。
410 Gone -[GET]：用户请求的资源被永久删除，且不会再得到的。
422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时，发生一个验证错误。
500 INTERNAL SERVER ERROR - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。

{
    error: "Invalid API key"
}

GET /collection：返回资源对象的列表（数组）
GET /collection/resource：返回单个资源对象
POST /collection：返回新生成的资源对象
PUT /collection/resource：返回完整的资源对象
PATCH /collection/resource：返回完整的资源对象
DELETE /collection/resource：返回一个空文档

无

无

{
	email :
	password : 
	nickname :
}

无

无

无

无

无

无

无

无

无

无

无

无

无