Skip to content

【功能】提供可配置的tags生成功能 #57

@MZ-Dlovely

Description

@MZ-Dlovely

来源

由工作上ApiFox导出的OpenAPI格式json引发的思考,ApiFox导出OpenAPI格式json时可选**是否将API文档的目录作为Tags字段导出:

  • 是:生成的tags为"tags": ["**/**/**"],其中星号为目录名,常为中文且易变动
  • 否:不生成tags

期待

如果有可配置的tags生成功能,我们就可以自定义地从url中提取出我们想要的tags,例如:

alova.config.ts
export default {
  generator: {
    ...
    // handleResolveTags(apiDescriptor) { return apiDescriptor.tags }
    handleResolveTags(apiDescriptor) {
      const tags = apiDescriptor.url.split('/').filter(Boolean);
      return tags
    }
  }
}

结果

以常见的鉴权与获取信息接口为例,可能存在以下接口:

  • /auth/login
  • /auth/logout
  • /user/info
  • /user/codes

虽然没有tags,但可以按配置生成tags,然后分类为authuser,以避免全部归类到默认的general

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions