使用Express開發小說API接口服務1.0（一）

時間 2019-12-07

標籤使用 express 開發 api 接口服務 1.0 简体版

原文原文鏈接

使用Express開發小說API接口服務1.0（一）

1.0版本技術棧使用express-generator、express、request、morgan、file-stream-rotator。接口用追書神器API。
目前接口設計有首頁，小說詳情頁，搜索，小說文章列表頁，排行API。
git

github建立倉庫

先建立一個倉庫放文件

而後克隆建立好的倉庫github

git clone https://github.com/lanpangzhi/novel-api.git

安裝 express-generator 快速生成項目

npm install -g express-generator

而後再以前克隆倉庫的上一級目錄執行express

express --no-view novel-api
cd novel-api
npm install 
npm install request file-stream-rotator -S
// Linux MacOS
DEBUG=novel-api:* & npm start
// windows 
set DEBUG=novel-api:* & npm start

生成好的目錄結構和文件
npm

設置cors 跨域

打開項目根目錄app.js,放在路由上面。json

app.all('*', function (req, res, next) {
    res.header("Access-Control-Allow-Origin", "*");
    res.header("Access-Control-Allow-Headers", "Origin, X-Requested-With, Content-Type, Accept");
    res.header("Access-Control-Allow-Methods", "PUT,POST,GET,DELETE,OPTIONS");
    res.header("X-Powered-By", ' 3.2.1')
    res.header("Content-Type", "application/json;charset=utf-8");
    next()
});

日誌寫入本地文件

按時間分割log日誌並寫入本地磁盤，須要在app.js文件中引入fs和file-stream-rotator模塊。windows

let fs = require('fs'); 
let FileStreamRotator = require('file-stream-rotator');  // 日誌按時間分割模塊

// 下面代碼寫在var app = express();下面
let logDir = path.join(__dirname, 'log');

// 檢查是否存在logDir這個目錄沒有則建立
fs.existsSync(logDir) || fs.mkdirSync(logDir);

// 日誌分割流
let accessLogStream = FileStreamRotator.getStream({
    date_format: 'YYYYMMDD',
    filename: path.join(logDir, 'access-%DATE%.log'),
    frequency: 'daily',
    verbose: false
});

// 日誌中間件
app.use(logger('combined', { stream: accessLogStream }));

建立公共文件

項目根目錄建立common文件夾，再裏面再新建一個common.json文件api

{
    "API": "http://api.zhuishushenqi.com",
    "PIC": "http://statics.zhuishushenqi.com",
    "CHAPTER": "http://chapter2.zhuishushenqi.com"
}

API域名: http://api.zhuishushenqi.com
圖片域名: http://statics.zhuishushenqi.com
章節域名: http://chapter2.zhuishushenqi...跨域

首頁接口

1.0版本首頁接口直接返回最熱榜前20條數據。
修改app.js 文件路由中間件配置app

app.use('/index', indexRouter);

修改routes/index.js 文件cors

let express = require('express');
let request = require('request');
let common = require('../common/common.json'); // 引用公共文件
let router = express.Router();

/** 
  首頁數據追書最熱榜 Top100
  獲取單一排行榜
  http://api.zhuishushenqi.com/ranking/{rankingId}
*/
router.get('/', function(req, res, next) {
  // 請求追書最熱榜 Top100
  request.get(`${common.API}/ranking/54d42d92321052167dfb75e3`, function (error, response, body) {
    if (error){
      res.send(JSON.stringify({"flag": 0, "msg": "請求出錯了..."}));
    }
    
    // 解析返回數據取前20條，並添加圖片url連接
    body = JSON.parse(body);

    if (body.ok){
      let books = body.ranking.books.slice(0, 19);
      books.forEach(element => {
        element.cover = common.PIC + element.cover;
      });

      res.send(JSON.stringify({ "flag": 1, "books": books, "msg": "OK" }));
    }else{
      res.send(JSON.stringify({ "flag": 0, "msg": "rankingId有問題" }));
    }  
  });
});

module.exports = router;

訪問http://localhost:3000/index 就能夠看到返回的數據了。

搜索接口

1.0版本的搜索接口只取前40條數據，能夠模糊查詢。
修改app.js 文件路由中間件配置，把users刪掉。

let searchRouter = require('./routes/search');
app.use('/search', searchRouter);

而後把routes文件夾下面的users.js刪除，新建search.js

let express = require('express');
let request = require('request');
let common = require('../common/common.json'); // 引用公共文件
let router = express.Router();

/** 
  模糊搜索接口
  返回模糊搜索前40條數據
  http://api.zhuishushenqi.com/book/fuzzy-search?query={name}
*/
router.get('/', function(req, res, next) {
  // 判斷query參數有沒有傳遞過來
  if (req.query.query){
    // req.query.query 編碼轉義
    let query = encodeURIComponent(req.query.query);
    request.get(`${common.API}/book/fuzzy-search?query=${query}`, function (error, response, body) {
      if (error){
        res.send(JSON.stringify({ "flag": 0, "msg": "請求出錯了..." }));
      }

       // 解析返回數據
      body = JSON.parse(body);

      if (body.ok){
        if (body.books.length == 0){
          res.send(JSON.stringify({ "flag": 0, "msg": "沒有找到書籍，換個名字試試吧。" }));
        }
        
        // 取前40條，並添加圖片url連接
        let books = body.books.slice(0, 39);
        books.forEach(element => {
          element.cover = common.PIC + element.cover;
        });

        res.send(JSON.stringify({ "flag": 1, "books": books, "msg": "OK" }));
      }else{
        res.send(JSON.stringify({ "flag": 0, "msg": "請求出錯了..." }));
      }
    });
  }else{
    res.send(JSON.stringify({"flag": 0, "msg": "請傳入query參數"}));
  }
  
});

module.exports = router;

訪問http://localhost:3000/search/?query=遮天就能夠看到返回的數據了。