使用node的Hapi框架搭建后台（二）——配置接口文档和入参校验

Bertha 。 2022-03-26 13:29 414阅读 0赞

# 一、配置接口文档 #

## Step 1：安装基础依赖和基础插件配置 ##

使用 Swagger 插件配置接口文档，安装适配 hapi v16 的 swagger 插件

npm i hapi-swagger@7
    npm i inert@4
    npm i vision@4
    npm i package

## Step 2：存放插件 ##

在根目录下创建 plugins 文件夹，用来存放插件，并新建 hapi-swagger.js ：

const inert = require('inert');
    const vision = require('vision');
    const package = require('package');
    const hapiSwagger = require('hapi-swagger');
    
    module.exports = [
      inert,
      vision,
      {
        register: hapiSwagger,
        options: {
          info: {
            title: '接口文档',
            version: package.version,
          },
          // 定义接口以 tags 属性定义为分组
          grouping: 'tags',
          tags: [
            {name: 'tests', description: '测试相关'}
          ]
        }
      }
    ]

## Step 3：创建路由并验证接口文档 ##

在根目录下创建 routes 文件夹，并新建 hello.js 文件

module.exports = [
      {
        method: 'GET',
        path: '/',
        handler: (request, reply)=>{
          reply('hello');
        },
        config: {
          tags: ['api','tests'],
          description: '测试hello'
        }
      }
    ]

## Step 2：挂载插件 ##

在 app.js 中，我们通过 server.register 挂载 swagger 插件配置。

const Hapi = require('hapi');
    require('env2')('./.env');
    const config = require('./config');
    const hello = require('./routes/hello');
    const pluginHapiSwagger = require('./plugins/hapi-swagger');
    
    const server = new Hapi.Server();
    // 配置服务器启动的 host 和端口
    server.connection({
      host: config.host,
      port: config.port
    })
    const init = async () => {
      await server.register([
        // 为系统使用 hapi-swagger
        ...pluginHapiSwagger,
      ]);
      server.route([
        ...hello,
      ])
      await server.start();
      console.log(`Server running at: ${server.info.uri}`);
    }
    
    init();

此时，执行 `node app.js`，然后访问 [http://127.0.0.1:3000/documentation][http_127.0.0.1_3000_documentation] 就能看到接口文档了。

# 二、入参校验 #

## Step 1：安装 Joi 依赖库 ##

安装适配 hapi v16 的 joi依赖

npm i --save joi@13

[http_127.0.0.1_3000_documentation]: http://127.0.0.1:3000/documentation

发表评论取消回复

表情：

评论列表（有 0 条评论，414人围观）

还没有评论，来说两句吧...

相关阅读

相关 Node.js框架对比：Express/Koa/Hapi

Node.js框架对比：Express/Koa/Hapi 引言 Express.js是当今使用最广泛的Node.js Web应用程序框架。它似乎是大多数Nod

素颜马尾好姑娘i/ 2023年07月26日 05:41/ 0 赞/ 17 阅读

相关用自己写的接口文档生成工具生成入参出参文档

用自己写的接口文档生成工具生成入参出参文档下载建工程安装附图用自己写的接口文档生成工具生成

柔情只为你懂/ 2022年07月13日 09:49/ 0 赞/ 289 阅读

相关 Node.js 服务器端框架 Hapi.js

Hapi.js 详细介绍 Hapi.js 是一个用来构建基于 Node.js 的应用和服务的富框架，使得开发者把重点放在便携可重用的应用逻辑而不是构建架构。内建输入验证、缓存

清疚/ 2022年05月17日 09:50/ 0 赞/ 153 阅读

相关 node.js搭建接口（五）：Node-搭建登录接口

// $route POST api/users/login // @desc 返回token jwt passport // @access publ

本是古典何须时尚/ 2022年05月15日 02:07/ 0 赞/ 364 阅读

相关 node.js搭建接口（二）：Node-连接MongoDB数据库

首先，在服务器文件夹目录下安装mongoose npm install mongoose 然后在入口文件中引入mongoose。 const mong

绝地灬酷狼/ 2022年05月15日 00:43/ 0 赞/ 243 阅读

相关 node.js搭建接口（十二）：Node-删除信息接口

需要删除信息，首先遍历用户item，查找到与登录用户id的下标 const removeIndex = profile.experience.map(item =>

今天药忘吃喽~/ 2022年05月14日 00:12/ 0 赞/ 407 阅读

相关使用node的Hapi框架搭建后台（四）——定义model

Step 1 ：开启下划线命名规范由于我们希望遵循 MySQL 数据库表字段的下划线命名规范，所以，需要全局开启一个 `underscore: true` 的定义，来使

灰太狼/ 2022年04月22日 23:14/ 0 赞/ 186 阅读

相关使用node的Hapi框架搭建后台（三）——通过sequelize插件使用mysql

Step 1 ：安装依赖 npm i sequelize-cli -D npm i sequelize npm i mysql2 Step 2

太过爱你忘了你带给我的痛/ 2022年03月26日 14:52/ 0 赞/ 239 阅读

相关使用node的Hapi框架搭建后台（二）——配置接口文档和入参校验

一、配置接口文档 Step 1：安装基础依赖和基础插件配置使用 Swagger 插件配置接口文档，安装适配 hapi v16 的 swagger 插件

Bertha 。/ 2022年03月26日 13:29/ 0 赞/ 415 阅读

相关使用node的Hapi框架搭建后台（一）——搭建项目

Step 1：初始化 Node.js 项目在控制台下输入 `npm init` 生成项目初始化 package.json 文件，并填写开发者信息、项目描述、代码仓库地址

左手的ㄟ右手/ 2022年03月26日 01:30/ 0 赞/ 344 阅读