接⼝设计
⼀、接⼝设计规范：RESTful
①参考⽂档：、
②HTTP协议⾥⾯，四个表⽰操作⽅式的动词：GET、POST、PUT、DELETE。它们分别对应四种基本操作：GET⽤来获取资源，POST⽤来新建资源（也可以⽤于更新资源），PUT⽤来更新资源，DELETE⽤来删除资源。
③具体：
GET（SELECT）：从服务器取出资源（⼀项或多项）。
POST（CREATE）：在服务器新建⼀个资源。
PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。
PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性）。
DELETE（DELETE）：从服务器删除资源。
HEAD：获取资源的元数据。
OPTIONS：获取信息，关于资源的哪些属性是客户端可以改变的。
⼆、案例（基于RESTful接⼝设计规范来设计接⼝）
①把SQL语句导⼊MySQL数据库，⽣成数据表
--Community management website
CREATE DATABASE IF NOT EXISTS cms;
use cms;
-- ⽤户表
CREATE TABLE users(
id INT PRIMARY KEY auto_increment,
username VARCHAR(50) NOT NULL, -- ⽤户名
password VARCHAR(50) NOT NULL, -- 密码
email VARCHAR(50) NOT NULL, -- 邮箱
avater VARCHAR(100) NULL, -- 头像
gender bit NULL, --性别
create_time DATETIME NOT NULL, -- 创建时间
modify_time DATETIME NOT NULL, -- 修改时间
nickname VARCHAR(50) NOT NULL -- 昵称
);
-- 话题表
CREATE TABLE topics(
id INT PRIMARY KEY auto_increment,
title VARCHAR(100) NOT NULL, -- ⽂章标题
content TEXT NOT NULL, -- ⽂字内容
user_id INT NOT NULL, -- 所属⽤户
create_time DATETIME NOT NULL, -- 发布时间
modify_time DATETIME NOT NULL -- 修改时间
);
-- 评论表
CREATE TABLE comments(
id INT PRIMARY KEY auto_increment,
content TEXT NOT NULL, -- 评论内容
create_time DATETIME NOT NULL, -- 评论时间
restful接口详解modify_time DATETIME NOT NULL,
article_id INT NOT NULL, -- 所属⽂章
user_id INT NOT NULL, -- 所属⽤户
reply_id INT NULL -- 所属回复⼈
);
②创建⽬录结构
③设计路由，编写路由代码，编写控制器函数 router.js
const express = require('express');
const router = express.Router() ;
const userController = require('./controllers/user');
const topicsController = require('./controllers/topic');
const commentController = require('./controllers/comment');
const sessionController = require('./controllers/session');
//⽤户资源
router
.get('/users',userController.list)
.post('/users',ate)
.patch('/users/:id',userController.update)
.delete('/users/:id',userController.destroy)
//话题资源
router
.get('/topics',topicsController.list)
.
post('/topics',ate)
.patch('/topics/:id',topicsController.update)
.delete('/topics/:id',topicsController.destroy)
//评论资源
router
.get('/comments',commentController.list)
.post('/comments',ate)
.patch('/comments/:id',commentController.update)
.delete('/comments/:id',commentController.destroy)
//会话资源
router
.
get('/session',)
.post('/session',ate)
.delete('/session/:id',sessionController.destroy)
//导出router （重要）
④封装 Promise版本的db.query⽅法 db.js
const mysql = require('mysql');
// 使⽤连接池：效率更⾼，不需要每次操作数据库都要三步⾛
const pool =atePool({
host:'localhost',
user:'root',
password:'123456',
database:'cms'
});
exports.query = function(sqlStr){
// 从连接池从拿⼀个连接，使⽤promise的⽅法
return new Promise((resolve,reject) =>{
if(err){
return reject(err)
}
connection.query(sqlStr,(err,...args) => {
/
/ 操作完连接，尽早释放连接
if(err){
return reject(err)
}
resolve(...args)
})
})
})
}
⑤⽤户管理：创建⽤户 user.js
const md5 = require('blueimp-md5');
const moment = require('moment');
const db = require('../models/db');
exports.list = (req,res,next) => {
//待完成
};
const body=req.body;
const sqlStr=`
INSERT INTO users(username,password,email,avater,gender,create_time,modify_time,nickname) VALUES(
'${ail}',
'${md5(md5(body.password))}',
'${ail}',
'default-avater.png',
0,
'${moment().format('YYYY-MM-DD hh:mm:ss')}',
'${moment().format('YYYY-MM-DD hh:mm:ss')}',
'${body.nickname}'
)`;
// 利⽤try-catch捕获异常:try中的代码⼀旦出错，⽴即进⼊catch代码块
try{
const ret = await db.query(sqlStr)
const users = await db.query(`SELECT * FROM users WHERE id='${ret.insertId}'`)
body.id = ret.insertId
res.status(201).json(users[0])
}catch(err){
res.status(500).json({
ssage
})
}
};
exports.update = (req,res,next) => {
// 待完成
};
exports.destroy = (req,res,next) => {
// 待完成
};
⑥会话管理：创建会话，获取会话信息，销毁会话 session.js
const md5 = require('blueimp-md5')
const db = require('../models/db')
// 获取登陆状态
< = (req,res,next) => {
const {user} = req.session
if(!req.session.user){
return res.status(401).json({
error: 'Unauthorized'
})
}
res.status(200).json(user)
}
// 创建登陆状态
try{
// 接收表单数据
const body=req.body
body.password = md5(md5(body.password))
// 处理数据库登陆请求
const sqlStr=`
SELECT * FROM users WHERE email='${ail}' and password='${body.password}'` const [user] = await db.query(sqlStr)
// 发送响应
if(!user){
return res.status(404).json({
error:'Invalid email or password!'
})
}
req.session.user = user
res.status(201).json(user)
}catch(err){
next(err)
}
}
// 删除登陆状态
exports.destroy = (req,res,next) => {
delete req.session.user
res.status(201).json({})
}
⑦话题管理：创建话题，话题分页列表，删除话题，更新话题 topic.js
const moment = require('moment')
const db = require('../models/db')
// 分页查询获取所有话题
exports.list = async(req, res, next) => {
let {_page=1,_limit=20} =req.query //req.query⽤于获取get请求url ? 后⾯的参数
if(_page < 1){_page = 1}
if(_limit < 1){ _limit = 1}
if(_limit > 20){_limit = 20}
const start = (_page-1)*_limit
try {
/*
第1页 0 20
第2页 20 20
第3页 40 20
第n页 (_page-1)*_limit _limit
*/
const sqlStr = `SELECT * FROM topics LIMIT ${start},${_limit}`
const topics = await db.query(sqlStr)
res.status(200).json(topics)
} catch (error) {
next(error)
}
}
// 创建话题
try{
// 登陆校验
const {user} = req.session
if(!user){
return res.status(401).json({
error:'Unauthorized'
})
}
const body = req.body
body.user_id = user.id
const sqlStr = `
INSERT INTO topics(title,content,user_id,create_time,modify_time)
VALUES('${body.title}','${t}','${body.user_id}','${ate_time}','${dify_time}')`
// 注意：query⽅法查询返回的是⼀个数组，增删改返回的是对象
const ret = await db.query(sqlStr)
const [topic] = await db.query(`SELECT * FROM topics WHERE id=${ret.insertId}`)
res.status(201).json(topic)
}catch(error){
next(error)
}
}
// 更新话题
exports.update = async (req, res, next) => {
try {
// 登陆校验
const {user} = req.session
if(!user){
return res.status(401).json({
error:'Unauthorized'
})
}
// id⼀致校验
const {id} = req.params
const [topic] = await db.query(`SELECT * FROM topics WHERE id=${id}`)
if(!topic){
return res,status(404).json({
error: 'this Topic Not Found'
})
}
if(topic.user_id !== req.session.user.id){
return res.status(400).json({
error: 'dupdate Invalid'
})
}
const body = req.body
const sqlStr = `
UPDATE topics SET title='${body.title}',content='${t}',modify_time='${moment().format('YYYY-MM-DD hh:mm:ss')}' WHERE id=${id}
`
await db.query(sqlStr)
const [updatedTopic] = await db.query(`SELECT * FROM topics WHERE id=${id}`)
res.status(201).json(updatedTopic)
} catch (error) {
next(error)
}
}
// 删除话题
exports.destroy = async (req, res, next) => {
try {
// 登陆校验
const {user} = req.session
if(!user){
return res.status(401).json({
error:'Unauthorized'
})
}
// url 中的:id叫做动态路由参数,
//总结：查询字符串req.query,post请求体req.body，动态路由参数req.params
const {id} = req.params
// 判断话题是否存在或者话题的ID是否和删除话题的ID⼀致
const [topic] = await db.query(`SELECT * FROM topics WHERE id=${id}`)
if(!topic){
return res,status(404).json({
error: 'this Topic Not Found'
})
}
if(topic.user_id !== req.session.user.id){
return res.status(400).json({
error: 'DELETE Invalid'
})
}
const sqlStr = `DELETE FROM topics WHERE id=${id}`
await db.query(sqlStr)
res.status(201).json({})
} catch (error) {
next(error)
}
}
⑧评论管理：创建评论
const db = require('../models/db')
const moment = require('moment')
exports.list = (req,res,next) => {
// 待补
}
try {
// 登陆校验
const {user} = req.session
if(!user){
return res.status(401).json({
error:'Unauthorized'
})
}
// 获取表单数据-->操作数据库-->发送响应数据
const body = req.body
const sqlStr = `
INSERT INTO comments(content,create_time,modify_time,article_id,user_id)
VALUES(
'${t}',
'${ate_time}',
'${dify_time}',
'${body.article_id}',
'${req.session.user.id}'
)`
const {insertId} = await db.query(sqlStr)
const [comment] = await db.query(`SELECT *FROM comments WHERE id=${insertId}`) res.status(201).json(comment)
} catch (error) {
next(error)
}
}
exports.update = (req,res,next) => {
// 待补
版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。
发表评论