_root

_root Properties

参数类型描述是否必需
namestring微应用名称,作为默认菜单名称。✓ Yes
typestring文件类型和版本,当前版本 micro-apps/v1.1✓ Yes
descriptionstring简单描述,支持多语言。No
defaultMenuIconIcon图标对象。No
privilegesarray[]权限列表。No
apisApi []微应用所有依赖 API 列表。No
appNamestring微应用名称,开发者唯一,用于标识微应用。✓ Yes
annotationsAnnotations注释,用于信息备注以及基于约定用于临时性的特性支持。No
supportedPlatformstring []支持平台。DESKTOP 代表桌面 web 应用,MOBILE 代表移动端。目前不支持两个平台同时使用,只能选择 ["DESKTOP"] 或 ["MOBILE"]。No
universalIdstring微应用全局唯一 ID,生成后不可变更,用于微应用跳转。No
appEnginestring运行微应用的引擎。
  • MICRO-FRONTEND,微应用使用微前端方式加载。目前,使用 qiankun。
  • WEB:目前用于移动端微应用,可选,Web 原生微应用专用。
  • NATIVE:原生应用 mobile 平台专用,预留,暂不支持。
  • TUYA-MINI-PROGRAM:涂鸦小程序引擎,mobile 平台专用,预留,暂不支持。
  • WX-MINI-PROGRAM:微信小程序。
✓ Yes
dependenciesstring []依赖微应用列表。如果当前微应用对别的微应用有依赖,建议添加被依赖的微应用universalID,我们会添加必要的提醒。No
entriesAppEntry []应用入口,一个微应用可以有一个或多个入口。No

Additional properties are allowed.

_root.name

微应用名称,作为默认菜单名称。

  • Type: string
  • Required: ✓ Yes

_root.type

文件类型和版本,当前版本 micro-apps/v1.1

  • Type: string
  • Required: ✓ Yes

_root.description

简单描述,支持多语言。

  • Type: string
  • Required: No

_root.defaultMenuIcon

图标对象。

  • Type: Icon
  • Required: No

_root.privileges

权限列表。

  • Type: array[]
  • Required: No

_root.apis

微应用所有依赖 Api 列表

  • Type: Api []
  • Required: No

_root.appName

微应用名称,开发者唯一,用于标识微应用。

  • Type: string
  • Required: ✓ Yes
  • Pattern: ^([a-z]|[0-9])[a-z0-9]?
  • Maximum Length: <= 100

_root.annotations

注释,用于信息备注以及基于约定用于临时性的特性支持。

  • Type: Annotations
  • Required: No

_root.supportedPlatform

支持平台。DESKTOP 代表桌面 web 应用,MOBILE 代表移动端。目前,不支持两个平台同时使用,只能选择 ["DESKTOP"] 或 ["MOBILE"]。

  • Type: string []
    • Each element in the array must be one of the following values:
      • DESKTOP
      • MOBILE
  • Required: No

_root.universalId

微应用全局唯一 ID,生成后不可变更,用于微应用跳转。

  • Type: string
  • Required: No

_root.appEngine

运行微应用的引擎。

  • MICRO-FRONTEND,微应用使用微前端方式加载。目前,使用 qiankun。
  • WEB:目前用于移动端微应用,可选,Web 原生微应用专用。
  • NATIVE:原生应用 mobile 平台专用,预留,暂不支持。
  • TUYA-MINI-PROGRAM:涂鸦小程序引擎,mobile 平台专用,预留,暂不支持。
  • WX-MINI-PROGRAM:微信小程序。
  • Type: string
  • Required: ✓ Yes
  • Allowed values:
    • "MICRO_FRONTEND"
    • "WEB"
    • "NATIVE"
    • "TUYA-MINI-PROGRAM"
    • "WX-MINI-PROGRAM"

_root.dependencies

依赖微应用列表。如果当前微应用对别的微应用有依赖,建议添加被依赖的微应用 universalID,我们会添加必要的提醒。

  • Type: string []
  • Required: No

_root.entries

应用入口。一个微应用可以有一个或多个入口。

  • Type: AppEntry []
  • Required: No

API

微应用依赖 API。

Api Properties

参数类型描述是否必需
namespacestringnamespace HTTP 头。目前用于 OPEN-API 接口,区分相同路由的不同接口。No
methodstringAPI HTTP 方法。✓ Yes
pathstringAPI 路径描述,如 /v1.0/users/{user_id}✓ Yes
typestringAPI 类型。
  • Open API 对应涂鸦开放 API 网关,微应用内通过 /open-api/ 前缀访问。
  • CustomAPI 对应用户自己部署服务内部 API 入口,微应用通过 custom-api api 前缀访问。
No
privilegeCodestring关联权限点的 Code。具体信息,可参考 #privileges。No

Additional properties are allowed.

Api.namespace

namespace HTTP 头。目前用于 OPEN-API 接口,区分相同路由的不同接口。

  • Type: string
  • Required: No

Api.method

API HTTP 方法。

  • Type: string
  • Required: ✓ Yes
  • Allowed values:
    • "get"
    • "post"
    • "put"
    • "delete"
    • "GET"
    • "POST"
    • "PUT"
    • "DELETE"

Api.path

API 路径描述,如 /v1.0/users/{user_id}

  • Type: string
  • Required: ✓ Yes

Api.type

API 类型。

  • Open API 对应涂鸦开放 API 网关,微应用内通过 /open-api/ 前缀访问。
  • CustomAPI 对应用户自己部署服务内部 API 入口,微应用通过 custom-api api 前缀访问。
  • Type: string
  • Required: No
  • Allowed values:
    • "OpenAPI"
    • "CustomerAPI"

Api.privilegeCode

关联权限点的 Code。具体信息,可参考 #privileges。

  • Type: string
  • Required: No

AppEntry

应用入口。

AppEntry Properties

参数类型描述是否必需
typestring入口类型。
  • QuickEntry:移动端快速入口。
  • Widget:移动端组件。
  • Menu:菜单。
✓ Yes
namestring入口名称,支持多语言。✓ Yes
pathstring入口路由。✓ Yes
codestring入口 ID,微应用内唯一。✓ Yes
appIconAppIcon应用图标,用于移动端微应用。尺寸 40×40 px,出血 3px,建议使用两倍图或三倍图。No
rationumber显示尺寸比例、高宽比。类型为 Widget 入口时必选。No

Additional properties are allowed.

AppEntry.type

入口类型。

  • QuickEntry:移动端快速入口

  • Widget:移动端组件

  • Menu:菜单

  • Type: string

  • Required: ✓ Yes

  • Allowed values:

    • "QuickEntry"
    • "Widget"
    • "Menu"

AppEntry.name

入口名称,支持多语言。

  • Type: string
  • Required: ✓ Yes

AppEntry.path

入口路由。

  • Type: string
  • Required: ✓ Yes

AppEntry.code

入口 ID,微应用内唯一。

  • Type: string
  • Required: ✓ Yes

AppEntry.appIcon

应用图标,用于移动端微应用。尺寸 40×40 px,出血 3px,建议使用两倍图或三倍图。

  • Type: AppIcon
  • Required: No

AppEntry.ratio

显示尺寸比例、高宽比。类型为 Widget 入口时必选。

  • Type: number
  • Required: No
  • Minimum: >= 0.5
  • Maximum: < 2

AppIcon

应用图标,用于移动端微应用。尺寸 40×40 px,出血 3px,建议使用两倍图或三倍图。

AppIcon Properties

参数类型描述是否必需
typestring图标类型:cdn。需要填写 URL。✓ Yes
urlstring文件地址。✓ Yes
sizestring文件像素尺寸,如 120x120✓ Yes

Additional properties are allowed.

AppIcon.type

图标类型:cdn。需要填写 URL。

  • Type: string
  • Required: ✓ Yes
  • Allowed values:
    • "cdn"

AppIcon.url

文件地址。

  • Type: string
  • Required: ✓ Yes

AppIcon.size

文件像素尺寸, 如 120x120

  • Type: string
  • Required: ✓ Yes

Icon

图标对象。

Icon Properties

参数类型描述是否必需
typestring图标类型。可选值:URLtuyaIcon。推荐使用 tuyaIcon✓ Yes
namestringIcon.typetuyaIcon 时必选,可以到 TuyaIcon 查看所有可用图标,推荐使用。No
urlstringIcon.typeURL 时必选,图标的 URL 地址。后续将不再支持,推荐使用 tuyaIcon 类型。No

Additional properties are allowed.

Icon.type

图标类型。可选值:URLtuyaIcon。推荐使用 tuyaIcon

  • Type: string
  • Required: ✓ Yes
  • Allowed values:
    • "URL"
    • "tuyaIcon"

Icon.name

Icon.typetuyaIcon 时必选,可以到 TuyaIcon 查看所有可用图标,推荐使用。

  • Type: string
  • Required: No

Icon.url

Icon.typeURL 时必选,图标的 URL 地址。后续将不再支持,推荐使用 tuyaIcon 类型。

  • Type: string
  • Required: No
  • Pattern: ^(http://|https://)

Privilege

微应用自定义权限。

Privilege Properties

参数类型描述是否必需
namestring权限点显示名称,支持多语言。✓ Yes
codestring权限编码,微应用内唯一。如果改变编码,会导致之前配置的权限信息丢失,用户需要重新配置该权限点。✓ Yes

Additional properties are allowed.

Privilege.name

权限点显示名称,支持多语言。

  • Type: string
  • Required: ✓ Yes

Privilege.code

权限编码,微应用内唯一。如果改变编码,会导致之前配置的权限信息丢失,用户需要重新配置该权限点。

  • Type: string
  • Required: ✓ Yes

Annotations

微应用信息备注以及基于约定用于临时性的特性支持。允许开发者添加除以下外的属性。

Annotations Properties

参数TypeDescriptionRequired
sdf.cli:microFrameworkstring框架类型✓ Yes
sdf.feat:colorThemeboolean是否支持主题色No
sdf.feat:i18nboolean开启动态多语言No
sdf.accessTypePUBLIC免登微应用(无 token 校验)No
sdf.main-app.menu.hide_in_menuboolean隐藏微应用的菜单入口No

Annotations.sdf.cli:microFramework

框架类型。

  • Type: string
  • Required: ✓ Yes
  • Allowed values:
    • "REACT_TS"
    • "REACT_JS"
    • "VUE_TS"
    • "VUE_JS"

Annotations.sdf.feat:colorTheme

是否支持主题色。

  • Type: boolean
  • Required: No

Annotations.sdf.feat:i18n

开启动态多语言。可以在 SaaS 零代码平台 -- 我的应用 管理多语言信息

  • Type: boolean
  • Required: No

Annotations.sdf.main-app.menu.hide_in_menu

隐藏微应用的菜单入口。

  • Type: boolean
  • Required: No