无法加载使用 serverless-auto-swagger 插件生成的 swagger URL 的 API 定义答案

【问题标题】：Failed to load API definition for swagger URL generated using serverless-auto-swagger plugin无法加载使用 serverless-auto-swagger 插件生成的 swagger URL 的 API 定义
【发布时间】：2023-02-13 19:05:24
【问题描述】：

我正在使用“serverless-auto-swagger”插件为我用 typescript 编写的无服务器 express API 生成一个 swagger 文档。

按照说明，我使用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

【问题讨论】：

标签： swagger swagger-ui serverless serverless-framework swagger-2.0

【解决方案1】：

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

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

【讨论】：