@ddn/swagger-docs

SwaggerUI 生成器，可根据 用户注释 自动生成 OpenAPI 的工具。

可以作为 Egg.js 插件使用，也可以作为命令行工具使用。应用启动后访问 /swagger-ui.html 可以浏览接口、测试接口，访问 /swagger-doc，直接获取获取 openapi.json 文件.

特别感谢：https://github.com/Yanshijie-EL/egg-swagger-doc

升级改进

1. [x] 支持 openAPI 3.0 版本，详细规范：openAPI v3.0.0；(如果想要支持 Swagger 2.0 规范，请使用原作者的插件)
2. [x] 支持 RESTful API 参数自动生成；
3. [x] 升级到最新版的 swagger-ui-dist 包；
4. [x] 使用生成的 http://localhost:7001/swagger-doc 生成前端的 Models，请使用插件 @ddn/openapi；
5. [x] 支持安全认证中间件自动映射：通过安全注解自动添加认证中间件，实现真正的安全验证；
6. [x] 智能路由排序：
   • 优先级规则：精准路径 (Static) > 动态参数 (Param) > 通配符 (Wildcard)，确保路由匹配的正确性；
   • 聚合规则：同类型的静态路径按字母顺序排序，确保同一模块的路由聚合在一起，不再混杂；
7. [x] 增强的环境兼容性：优化了 Swagger UI 静态资源的路径解析逻辑，完美支持 Docker、PnP 等复杂环境；
8. [ ] 支持命令行执行，保证平台无关性，支持除了 Egg.js 框架之外更多应用；
9. [ ] 更多功能待完善。

文档

• 安全认证技术文档 - 详细介绍安全认证功能的配置和使用方法

安装

$ npm i @ddn/swagger-docs --save

使用

// {app_root}/config/plugin.js
exports.swaggerdoc = {
  enable: true,
  package: '@ddn/swagger-docs',
};

设置

// {app_root}/config/config.default.js
exports.swaggerdoc = {
  dirScanner: './app/controller',
  apiInfo: {
    title: 'egg-swagger',
    description: 'swagger-ui for egg',
    version: '1.0.0',
  },
  servers: [
    {
      url: "https://petstore3.swagger.io/api/v3"
    },
    {
      url: "http://localhost:7200"
    }
  ],
  consumes: ['application/json'], 
  securitySchemas: {
    // apikey: {
    //   type: 'apiKey',
    //   name: 'clientkey',
    //   in: 'header',
    // },
    // oauth2: {
    //   type: 'oauth2',
    //   tokenUrl: 'http://petstore.swagger.io/oauth/dialog',
    //   flow: 'password',
    //   scopes: {
    //     'write:access_token': 'write access_token',
    //     'read:access_token': 'read access_token',
    //   },
    // },
  },
  enableSecurity: false,
  // enableValidate: true,
  enable: true,
  routerMap: false,
  routerCli: false, // 是否在启动时打印路由注册日志
  routerPath: '', // 路由映射文件导出路径，为空则不导出，例如 './run/router_map.md'
};

配置参数说明

| 参数 | 类型 | 默认值 | 说明 | | --- | --- | --- | --- | | dirScanner | String | './app/controller' | 插件扫描的文档路径 | | apiInfo | Object | - | Swagger 文档信息 | | securitySchemes | Object | - | 安全验证配置 | | enableSecurity | Boolean | false | 是否启用安全验证 | | enable | Boolean | true | 是否启用 Swagger UI, 会生成 http://localhost:7001/swagger-doc | | routerMap | Boolean | false | 是否自动生成路由（实验性功能） | | routerCli | Boolean | false | (新增) 是否在应用启动时，在控制台打印详细的路由注册日志，方便调试 | | routerPath | String | '' | (新增) 路由映射表导出路径。如果设置（如 ./run/router_map.md），启动时会将所有注册的路由导出为 Markdown 表格，方便查阅和比对 |

see config/config.default.js for more detail.

验证：

• 编辑器： https://editor-next.swagger.io/
• 中文文档: https://openapi.apifox.cn/
• 参考规范 https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md

介绍

完成插件引入之后，如果不修改默认配置，应用启动后，会自动扫描 app/controller 和 app/contract 下的文件。controller下的文件先不做描述。contract 下的文件为定义好的请求体和响应体。

实验性功能：如果 routerMap 为true, 允许自动生成API路由

@Controller

格式：@Controller {ControllerName}

a.如果文件第一个注释块中存在标签@Controller，应用会扫描当前文件下的所有注释块，否则扫描将会跳过该文件。
b.如果不标示ControllerName，程序会将当前文件的文件名作为ControllerName。

例：

/**
 * @Controller user
 */
class UserController extends Controller {
  //some method
}

@Router

格式：@Router {Mothod} {Path}

a.Mothod,请求的方法(post/get/put/delete等)，不区分大小写。
b.Path,请求的路由。

输出格式: Method + 操作 ID

例如:

• '* @router get /api/ledgers/' 输出: getLedgers
• '* @router get /api/ledgers/{id}' 输出: getLedgersById
• '* @router put /blogs/{id}' 输出: putBlogsById
• '* @router get /api/block/statistic' 输出: getBlockStatistic

@Request

格式：@Request {Position} {Type} {Name} {Description}

a.position.参数的位置,该值可以是body/path/query/header/formData.
b.Type.参数类型，body之外位置目前只支持基础类型,integer/string/boolean/number，及基础类型构成的数组，body中则支持contract中定义的类型。如果position是formData还将支持 file 类型
c.Name.参数名称.如果参数名称以*开头则表示必要，否则非必要。
d.Description.参数描述
c.如果你想给query或者path的参数设置example，你可以在Description前添加以'eg:'开头的参数，实例如下
@Request query string contactId eg:200032234567 顾问ID

@Response

格式：@Response {HttpStatus} {Type} {Description}

a.HttpStatus.Http状态码。
b.Type.同Request中body位置的参数类型。
d.Description.响应描述。

@Deprecated

如果注释块中包含此标识，则表示该注释块注明的接口，未完成或不启用。

@Description

格式：@Description {Description}

接口具体描述

@Summary

格式：@Summary {Summary}

接口信息小标题

例：

/**
 * @Controller user
 */
class HomeController extends Controller {
  /**
   * @Router POST /user
   * @Request body createUser name description-createUser
   * @Request header string access_token
   * @Response 200 baseResponse ok
   */
  async index() {
    this.ctx.body = 'hi, ' + this.app.plugins.swagger.name;
  }

如果在config中开启并定义了 securitySchemas,默认 enableSecurity 为false.则可在注释块中加入 @apikey，加入安全验证。也可定义成其他名字，只需@定义好的字段名就好。关于 securitySchemas 的定义可以自行搜索。

exports.swaggerdoc = {
  securitySchemas: {
    apikey: {
      type: 'apiKey',
      name: 'clientkey',
      in: 'header',
    },
    // oauth2: {
    //   type: 'oauth2',
    //   tokenUrl: 'http://petstore.swagger.io/oauth/dialog',
    //   flow: 'password',
    //   scopes: {
    //     'write:access_token': 'write access_token',
    //     'read:access_token': 'read access_token',
    //   },
    // },
  },
  enableSecurity: true,
};

contract定义

关于Contract的定义其实在测试代码里面，已经把支持的所有情况都定义出来了。详见here,这里我简单说明一下，以下是测试代码中的部分contract。

module.exports = {
  createResource: {
    resourceId: { type: 'string', required: true, example: '1' },
    resourceNametrue: { type: 'string', required: true },
    resourceType: { type: 'string', required: true, enum: ['video', 'game', 'image'] },
    resourceTag: { type: 'array', itemType: 'string' },
    owner: { type: 'User', required: true },
    owners: { type: 'array', itemType: 'User' }
  },
};

@基础类型

module.exports = {
  Model名称:{
    字段名称: { type: 字段类型，required: 字段必要性, example: 示例}
  }
}

注：type可以是array之外的类型，包括自定义的类型，目前自定义类型不支持example

@ENUM

module.exports = {
  Model名称:{
    字段名称: { type: 字段类型，required: 字段必要性, enum:[]}
  }
}

注: type只能是string或number，enum为具体的数值组成的集合

@ARRAY

module.exports = {
  Model名称:{
    字段名称: { type: "array"，required: 字段必要性, itemType:数组元素类型}
  }
}

type为array,itemType为具体的数组元素类型，支持自定义类型。

@自定义类型

关于自定义类型，必须定义在contract目录下，在contract下的其他类型中使用时，直接使用Model名称引入。

因为contract的定义和validate-rule的定义具有极大的相似性，所以目前的版本中定义contract的同时会简单的生成相应的validate-rule.具体的使用'ctx.rule.'加Model名称直接引入。

上面的model，在做验证的时候就可以使用如下的方式(需使用egg-validate)

ctx.validate(ctx.rule.createResource, ctx.request.body);

Questions & Suggestions

Please open an issue here.

License

MIT