5 минут, чтобы научить вас писать фиктивный сервер данных с помощью nodeJS

JavaScript

Для фронтенд-разработчиков javascript играет все более важную роль, он может не только расширять возможности браузера, но и иметь большое значение для веб-сервера (мы можем использовать nodeJS для написания кода на стороне сервера, запуска веб-сервера), поэтому в этой статье будет описано применение javascript на стороне сервера. Я расскажу, как использовать nodeJS для создания фиктивного сервера, чтобы упростить интерфейсные настраиваемые фиктивные запросы данных, улучшить инициативу разработчиков интерфейсов и изучить надежность проекта.

мы узнаем

  • Основное использование коа
  • Основное использование koa-router
  • Использование коа-логгера
  • glob поддерживает запросы обхода файлов
  • Использование нескольких основных API узла
  • Автоматический перезапуск с помощью nodemon

Основные идеи дизайна макета сервера

Чтобы получить доступ к нашему API через отношение сопоставления между путем к каталогу и серверным API, например, когда мы обращаемся к интерфейсу /api/article/122, нам нужно только создать файл 122.json в каталоге статьи API. в каталоге фиктивного периода обслуживания. , данные файла json можно настроить для облегчения отладки переднего плана.

Выполнение

1. Создайте службу узла

const Koa = require('koa');
const app = new Koa();
app.listen(3000)

2. Зарегистрируйте маршрут Мы используем koa-router для реализации функции маршрутизации фонового сервиса и возвращаем прочитанные данные во внешний интерфейс через контекст ctx, предоставляемый koa:

const Koa = require('koa');
const Router = require('koa-router');
 
const app = new Koa();
const router = new Router({prefix: '/api'});

router.get('/name', (ctx, next) => {
    ctx.body = {
        name: 'xuxiaoxi'
    }
  });

app
  .use(router.routes())
  .use(router.allowedMethods());
  
app.listen(3000)

Таким образом, мы можем реализовать базовый фоновый API-сервер, который практически не используется. Когда мы запрашиваем /api/name, он возвращает соответствующие данные на стойку регистрации.Этот шаг является ключевым для нас при реализации фиктивного сервиса. Далее мы специально реализуем обход каталога и автоматическую регистрацию API.

3. Автоматически зарегистрировать API-интерфейс и вернуть данные На этом этапе мы реализуем автоматическую регистрацию службы API.Здесь мы используем сторонний модуль glob для обхода каталога и считываем данные файла API через модуль fs узла и возвращаем его на передний план. Использовать glob очень просто, и заинтересованные друзья могут изучить его самостоятельно, поэтому я не буду вдаваться в подробности. Конкретная реализация выглядит следующим образом:

const Koa = require('koa');
const Router = require('koa-router');
const glob = require("glob");
const { resolve } = require('path');
const fs = require('fs');
 
const app = new Koa();
const router = new Router({prefix: '/api'});

// 注册路由
glob.sync(resolve('./api', "**/*.json")).forEach((item, i) => {
    let apiJsonPath = item && item.split('/api')[1];
    let apiPath = apiJsonPath.replace('.json', '');
    
    router.get(apiPath, (ctx, next) => {
        try {
            let jsonStr = fs.readFileSync(item).toString();
            ctx.body = {
                data: JSON.parse(jsonStr),
                state: 200,
                type: 'success' // 自定义响应体
            }
        }catch(err) {
            ctx.throw('服务器错误', 500);
        }
      });
});
 
app
  .use(router.routes())
  .use(router.allowedMethods());

app.listen(3000);
  1. Добавить журнал консоли Мы используем koa-logger для печати журналов узлов на терминале, что удобно для отладки.Хотя это не является предметом этой статьи, тем не менее, это необходимо для понимания интерфейсными практиками, которые хотят заниматься разработкой узлов.
const logger = require('koa-logger')
app.use(logger());

Таким образом, каждый наш запрос будет напечатан в терминале.

  1. Генерация файла карты маршрута Эта функция не является предметом этой статьи, но она значительно облегчит разработчикам интерфейса отладку запросов, потому что, если путь API очень длинный, нам нужно искать один за другим, но с этим файлом карты нам нужно только скопируйте автоматически сгенерированный путь. Конкретная реализация выглядит следующим образом:
//...
const routerMap = {};  // 存放路由映射

// 注册路由
glob.sync(resolve('./api', "**/*.json")).forEach((item, i) => {
    // ...
    
    // 记录路由
    routerMap[apiJsonPath] = apiPath;
});

fs.writeFile('./routerMap.json', JSON.stringify(routerMap, null , 4), err => {
    if(!err) {
        console.log('路由地图生成成功！')
    }
});

Базовая структура каталогов

полный код

клонировать адресгитхаб-адрес

Мы приглашаем всех учиться друг у друга и вместе исследовать границы интерфейса.

больше рекомендаций

Категории