无法加载使用无服务器自动swagger插件生成的swagger URL的API定义

vfh0ocws  于 2023-02-16  发布在  其他
关注(0)|答案(1)|浏览(153)

我正在使用'serverless-auto-swagger'插件为我的无服务器express API生成一个swagger文档,该文档是用typescript编写的。
按照说明,我用npm install -D serverless-auto-swagger安装了依赖项,然后在无服务器文件的插件中添加了“serverless-auto-swagger”。

plugins:
  - serverless-auto-swagger
  - serverless-bundle
  - serverless-dynamodb-local
  - serverless-offline

functions:
  api:
    handler: "./src/handler.handler"
    events:
      - http:
          path: basket/{basketId}
          method: get

使用serverless offline start启动离线服务器后,当我访问swagger URL时,我看到错误-无法加载API定义。获取错误未找到http://localhost:3000/dev/swagger/. json

llycmphe

llycmphe1#

您必须在custom下编写swagger配置:在serverless.yml文件中。例如,

custom:
    autoswagger:
        title: 'string'
        generateSwaggerOnDeploy: true | false
        typefiles: ['./src/types/typefile1.d.ts', './src/subfolder/helper.d.ts']
        apiKeyHeaders: ['Authorization', 'anyOtherName']
        basePath: '/string'
        host: 'http://some-host'
        schemes: ['http', 'https', 'ws', 'wss']
        excludeStages: ['production', 'anyOtherStage']

查看官方文档:https://www.npmjs.com/package/serverless-auto-swagger

相关问题