应用描述文件
更新时间：2024-12-19 05:56:40下载pdf
manifest.json 是微应用描述文件，位于项目根目录下，主要用于描述微应用的基础元信息。
元信息
微应用的元信息如下表所述：
| 参数 | 类型 | 描述 | 是否必需 | 支持多语言 |
|---|---|---|---|---|
| name | string |
微应用名称，作为默认菜单名称。 | 是 | 是 |
| type | string |
文件类型和版本，当前版本 micro-apps/v1.1。 |
是 | 否 |
| appName | string |
微应用名称，开发者唯一，用于标识微应用。 | 是 | 否 |
| annotations | Annotations {} |
注释，用于信息备注以及基于约定，用于部分过渡版本的特性支持。 | 是 | - |
| appEngine | string |
运行微应用的引擎，可选 MICRO-FRONTEND。 |
是 | - |
| description | string |
简单描述，支持多语言。 | 否 | 是 |
| defaultMenuIcon | Icon {} |
图标对象。 | 否 | - |
| privileges | array[] |
权限列表。 | 否 | - |
| apis | Api [] |
微应用所有依赖 API 列表。 | 否 | - |
| supportedPlatform | string [ Enum ] |
支持的平台：
DESKTOP 或 MOBILE。 |
否 | - |
| universalId | string |
微应用全局唯一 ID，生成后不可变更，用于微应用跳转。 | 否 | - |
| dependencies | string [] |
依赖微应用列表。如果当前微应用对别的微应用有依赖，建议添加被依赖的微应用 universalID。涂鸦会添加必要的提醒，以避免出现循环依赖。 |
否 | - |
| entries | Entries [] |
应用入口，可通过暴露的入口 Path 访问微应用。一个微应用可以有一个或多个入口。 | 否 | - |
annotations
可自定义扩展字段，用于记录针对微应用的备注信息，且自定义字段支持多语言。
annotations 对象结构如下：
| 参数 | 类型 | 描述 | 是否必需 |
|---|---|---|---|
| sdf.cli:microFramework | Enum |
标识当前微应用使用哪种技术类型的模板生成。枚举值包括：
|
是 |
| sdf.feat:colorTheme | boolean |
标识当前微应用需要开启主题色配置。 | 是 |
| sdf.feat:i18n | Enum |
应用发布时，会根据这个 key 判断是否读取 _locals 文件夹下的多语言用于在多语种环境下描述微应用。目前仅可选 DYNAMIC，或者不填该字段。 |
否 |
defaultMenuIcon
icon 将会作为微应用的图标，展示在 涂鸦开发者平台 上。
DefaultMenuIcon 对象结构如下：
| 参数 | 类型 | 描述 | 是否必需 |
|---|---|---|---|
| type | Enum |
微应用 icon 类型，可选值 URL。 |
是 |
| name | string |
微应用 icon 地址。如果不填，则使用默认 icon。
|
否 |
entries
entries 对象结构如下：
| 参数 | 类型 | 描述 | 是否必需 | 支持多语言 |
|---|---|---|---|---|
| type | Enum |
入口类型，可选 Menu。枚举值包括：
|
是 | 否 |
| name | string |
入口名称，当前支持的入口仅有菜单，可认为是菜单名称。 | 否 | 是 |
| code | Enum |
入口 ID，唯一标识。 | 是 | 否 |
| path | Enum |
访问路径。 | 是 | 否 |
| appIcon | AppIcon {} |
入口图标。 | 否 | 否 |
appIcon 对象结构如下：
| 参数 | 类型 | 描述 | 是否必需 |
|---|---|---|---|
| type | Enum |
入口类型，可选 CDN。 |
是 |
| url | string |
icon 资源地址。 |
否 |
| size | Enum |
图标大小，展示尺寸 40 × 40 px，建议提供二倍图或三倍图。 | 是 |
privileges
privileges 对象结构如下：
| 参数 | 类型 | 描述 | 是否必需 | 支持多语言 |
|---|---|---|---|---|
| name | string |
权限点显示名称。 | 是 | 是 |
| code | string |
权限编码，微应用内唯一，定义后不可变。如果发生改变，会导致之前配置的权限信息匹配不上，因而您需要在平台上重新配置 SaaS 权限。 | 是 | 否 |
apis
apis 对象结构如下：
| 参数 | 类型 | 描述 | 是否必需 |
|---|---|---|---|
| namespace | Enum |
入口类型，可选 CDN。 |
是 |
| method | Enum |
发起请求的方法。可选值包括：get、GET、post、POST、put、PUT、delete、DELETE。 |
是 |
| path | Enum |
发起请求的目标路径。 | 是 |
| privilegeCode | Enum |
可选权限点，可从 privileges 对象里获取对应的权限 code 填入。如果不填，默认不限制权限，即不需要任何权限校验，可正常请求。 |
否 |
该内容对您有帮助吗？
是意见反馈该内容对您有帮助吗？
是意见反馈
关注“涂鸦智能”
涂鸦服务尽在掌握
关注“全球智能商业”
第一时间获取物联网资讯
