如何将HapiJs连接到Swagger？
如何将HapiJs连接到Swagger？
提问于 2017-11-16 01:05:03
我正在尝试将Hapijs与swagger项目联系起来。我目前正在使用这个包
下面是我的代码：
const Inert = require('inert');
const Vision = require('vision');
server.register([
Inert,
Vision,
{
'register': require('hapi-swagger'),
'options': options
}
], (err) => {
server.start((err) => {
if (err) {
console.log(err);
} else {
console.log('Server running at:', server.info.uri);
}
});
});我收到了这个错误消息
if (plugin.register.register) { // Required plugin
^
TypeError: Cannot read property 'register' of undefined依赖关系
"hapi": "^16.6.2",
"hapi-swagger": "^8.0.0",回答 2
Stack Overflow用户
发布于 2017-11-19 23:09:43
我已经实现了这样的hapi swagger，希望这能为你工作。
'use strict';
const HapiSwagger = require('hapi-swagger');
const Inert = require('inert');
const Vision = require('vision');
const Config = require('config');
const DatabaseSetting = Config.get('DatabaseSettings');
//Register Swagger
const Pack = require('../package');
exports.register = (server, options,next) => {
server.register([
Inert,
Vision,
{
'register': HapiSwagger,
'options': {
'info': {
'title': `API Documentation for ${DatabaseSetting.env} environment`,
'version': Pack.version,
//'description':'Please use "accept :application/vnd.easyme.version.v1+json" for api versioning'
},
'schemes': ['http'],
'pathPrefixSize':2,
'basePath': '/',
documentationPath:'/doc',
debug:true
}
}], (err) => {
if (err) {
server.log(['error'], `hapi-swagger load error: ${err}`)
}else{
server.log(['start'], 'hapi-swagger interface loaded')
}
});
next();
};
exports.register.attributes = {
name: 'swagger-plugin'
};在server.js上，我有一个导入文件，并注册如下
// Register All Plugins
server.register(Plugins, err => {
if (err) {
server.error(`Error while loading plugins : ${err}`)
} else {
server.log('info', 'Plugins Loaded')
}
})Stack Overflow用户
发布于 2017-11-29 20:26:04
我已经为swagger插件注册创建了一个单独的文件。您可以添加类似的文件，只需传递服务器上下文即可注册插件。
如果您在项目中不使用Winston and Raven (Sentry.io)，则可以将其删除。
来自package.json的代码片段
"hapi": "^16.6.2",
"hapi-swagger": "^8.0.0",
"inert": "^4.2.1",
"vision": "^4.1.1",hapi-swagger.js
/**
* Embeds Hapi-Swagger plugin to the server
*/
/* jslint node: true */
/* jshint esversion: 6 */
'use strict';
const Inert = require('inert');
const Vision = require('vision');
const Winston = require('logger/WinstonPlugin');
const Raven = require('errors/RavenPlugin');
const environment = require('config').environment;
const port = require('config').port;
const swaggerOptions = {
info: {
title: 'API Documentation - [' + environment + ':' + port + ']'
},
tags: [{
name: 'user',
description: 'Related to User Object'
}, {
name: 'email',
description: 'For verification of User Email'
}, {
name: 'session',
description: 'Session Management'
}, {
name: 'account',
description: 'User Account'
}],
jsonEditor: true,
grouping: 'tags',
securityDefinitions: {
Bearer: {
type: 'apiKey',
name: 'Authorization',
in: 'header',
"scopes": {
"write:pets": "modify pets in your account",
"read:pets": "read your pets"
}
}
}
};
/**
* Registers Swagger Plugin in Hapi Server object
* @param {*} server - Hapi.Server
*/
function RegisterSwaggerPlugin(server) {
if (!server) return;
server.register([Inert, Vision,
{
register: require('hapi-swagger'),
options: swaggerOptions
}
], function (err) {
if (err) {
Winston.error(['error'], 'hapi-swagger load error: ' + err);
Raven(err);
} else {
Winston.debug('hapi-swagger interface loaded');
}
});
}
module.exports = RegisterSwaggerPlugin;您可以从server.js文件中注册插件，如下所示。
server.js
// Add Swagger Plugin here
require('plugin-registration/hapi-swagger')(server);这样，当你想阻止插件注册的时候，你只需要注释一行就可以了。
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接：
https://stackoverflow.com/questions/47313303
复制相关文章
相似问题
腾讯云开发者
