我一直在节点应用程序中使用Swagger和自定义配置和目录结构。
这是我app.js的片段
var swaggerConfig = {
appRoot: config.get('app_root'),
configDir: 'swagger/config',
swaggerFile: 'swagger/api.yaml'
};
SwaggerExpress.create(swaggerConfig, function(err, swaggerExpress) {
if (err) { throw err; }
swaggerExpress.register(app);
});
在具有标准YAML配置swagger/config
的config default.yml
目录下。
# swagger configuration file
# values in the swagger hash are system configuration for swagger-node
swagger:
fittingsDirs: [ app/fittings ]
defaultPipe: null
swaggerControllerPipe: swagger_controllers # defines the standard processing pipe for controllers
# values defined in the bagpipes key are the bagpipes pipes and fittings definitions
# (see https://github.com/apigee-127/bagpipes)
bagpipes:
_router:
name: swagger_router
mockMode: false
mockControllersDirs: [ app/mocks ]
controllersDirs: [ app/controllers ]
_swagger_validate:
name: swagger_validator
validateResponse: true
# pipe for all swagger-node controllers
swagger_controllers:
- onError: json_error_handler
- cors
- swagger_security
- _swagger_validate
- express_compatibility
- _router
# pipe to serve swagger (endpoint is in swagger.yaml)
swagger_raw:
name: swagger_raw
# any other values in this file are just loaded into the config for application access...
现在问题在控制器req.swagger.params
上总是返回null
。
答案 0 :(得分:4)
文档中不清楚这一点,但您还需要在swagger_params_parser
中的swagger_controllers
部分添加default.yaml
。
bagpipes:
_router:
name: swagger_router
mockMode: false
mockControllersDirs: [ api/mocks ]
controllersDirs: [ api/controllers ]
_swagger_validate:
name: swagger_validator
validateResponse: true
# pipe for all swagger-node controllers
swagger_controllers:
- swagger_params_parser
- cors
- swagger_security
- _swagger_validate
- _router