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

最新推荐文章于 2024-08-30 09:16:48 发布

怪力马猴烧酒

最新推荐文章于 2024-08-30 09:16:48 发布

阅读量1.2k

点赞数

分类专栏： node.js Hapi 记录文章标签： node hapi

本文链接：https://blog.csdn.net/August_leo/article/details/86522874

版权

本文档介绍了如何使用Node.js的Hapi框架搭建后台，重点讲解了配置Swagger接口文档的三个步骤，包括安装依赖、存放插件和创建验证接口文档。同时，还阐述了入参校验的初步步骤，即安装Joi依赖库。

摘要由CSDN通过智能技术生成

一、配置接口文档

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: '测试相关'}
      ]
    }
  }
]