# 查看自定义接口 #### 使用说明 当前端页面，如业务大屏页面中，需要调用自定义接口时，可在"自定义接口"中查看自定义接口的URL和其他信息。 图1配置组件数据来源 ![](https://support.huaweicloud.com/usermanual-astrozero/zh-cn_image_0000001960124477.png "点击放大") #### 操作步骤 1. 参考[登录管理中心](https://support.huaweicloud.com/usermanual-astrozero/astrozero_06_2092.html)中操作，登录AstroZero管理中心。 2. 在左侧导航栏中，选择"系统管理 \> 自定义接口"，查看该账号下创建的所有自定义接口。 3. 单击自定义接口列表中的操作名称，可查看接口详情。 表1接口详情页参数说明 | 参数 | 参数说明 | |:---|:---| | 标签 | 创建自定义接口时，配置的标签。 | | 操作名称 | 创建自定义接口时，配置的名称。 | | 版本 | 接口对应的版本号。 | | 分类 | 该接口所属的分类。 | | 允许匿名访问 | 是否可匿名访问运行环境中该API接口。 勾选表示允许匿名访问，通过运行环境子域名访问此接口时，如果无有效的Token认证信息，则以匿名用户身份继续访问此接口，使用的是"Anonymous User Profile"权限，匿名用户身份访问不需要做CSRF校验。当该接口有配置业务权限凭证时，给"Anonymous User Profile"权限添加相应业务权限凭证，即可通过运行环境子域名匿名访问该接口。 - 需要支持匿名访问自定义接口的账号，必须要设置运行环境子域名。 - 该选项默认不勾选，允许匿名访问时需要手动勾选，若该接口为只读保护，在开发环境自定义该接口时就需要勾选该选项。 - 带有合法认证信息来访问允许匿名访问的自定义接口时，优先以合法认证的身份权限来访问。 - 匿名用户身份访问自定义接口，不需要做CSRF校验。 - 不论以什么方式来访问， 认证身份后做的权限校验保持一致。如果配置了业务权限凭证，还是会查看用户权限是否配置相应业务权限凭证。 例如：登录业务应用接口"login"的URL为"/service/trq1__MyApp/1.0.0/login"，运行环境子域名为"test.example.com"，该接口勾选了"允许匿名访问"，且"Anonymous User Profile"权限配置了该接口的业务权限凭证，则匿名用户通过"https://test.example.com/service/trq1__MyApp/1.0.0/login"即可访问该接口。 | | 是否已废弃 | 该接口是否已废弃。 | | 描述 | 该接口的描述信息。 | | 创建时间 | 自定义接口的创建时间。 | | 最后修改人 | 自定义接口的最后修改人。 | | 最近修改时间 | 最近修改自定义接口的时间。 | | API类型 | 接口API类型。 | | 方法 | 映射后调用的方法名，如GET（查询）、PUT（增加）、POST（修改）和DELETE（删除）。 | | URL | 接口的URL地址。 单击URL后的复制按钮![](https://support.huaweicloud.com/usermanual-astrozero/zh-cn_image_0000001932885752.png)，可将该接口的URL复制出来，在需要调用该接口URL的地方直接配置即可。 | | 类型 | 接口的类型。 - 服务编排：表示该定义URL调用的接口类型是服务编排。 - 脚本：表示该定义URL调用的接口类型是脚本。 - 对象：表示该定义URL是操作对象数据，包括对象数据的增删改查。 | | 资源 | 调用的服务编排、脚本或者操作的对象名称。 | | 内容类型 | 请求中的body类型。 - application/json - multipart/from-data - binary-data "multipart/from-data"和"binary-data"用于文件上传接口，选择该内容类型，只能调用post类型的脚本。 | | 自定义响应 | 是否需要格式化调用该URL后返回的响应消息。如果勾选，表示对响应消息进行格式化，删除resCode、resMsg、result外层信息，只透传返回的消息。 - 不勾选"自定义响应"，返回如下响应消息： ``` { "resCode": "0", "resMsg": "成功", "result": [ { "equipments": [ { "createdBy": "aaa", "createdBy.__objectType": "User" }, { "createdBy": "aaa", "createdBy.__objectType": "User" } ], "total": "2" } ] } ``` - 勾选"自定义响应"，只返回如下响应消息： ``` { "equipments": [ { "createdBy": "aaa", "createdBy.__objectType": "User" }, { "createdBy": "aaa", "createdBy.__objectType": "User" } ], "total": "2" } ``` | | 兼容模式 | 自定义接口所属的应用版本大于1.3.7时，才会显示该参数。 - 勾选该选项，将使用AstroZero（原AppCube） 1.3.6以前版本的兼容模式，在输出的结构基础上封装一层数组。 - 不勾选，表示输出的结构不会封装。 | | 业务权限凭证 | 单击"编辑"，在"业务权限凭证列表"中选择需要添加的业务权限凭证，单击![](https://support.huaweicloud.com/usermanual-astrozero/zh-cn_image_0000001960124481.png "点击放大")，将选择的业务权限凭证添加至右侧列表，单击"保存"，可给接口添加业务权限凭证。 | 4. 预览测试接口。 1. 在自定义接口列表中，单击接口所在行的![](https://support.huaweicloud.com/usermanual-astrozero/zh-cn_image_0000001960124469.png)，预览接口。 若为公共接口，支持查看接口参数并进行在线测试。若为私有接口，只可查看接口的入参和出参。 图2公共接口 ![](https://support.huaweicloud.com/usermanual-astrozero/zh-cn_image_0000001933045156.png "点击放大") 图3私有接口 ![](https://support.huaweicloud.com/usermanual-astrozero/zh-cn_image_0000001932885756.png "点击放大") 2. 单击接口URL后的![](https://support.huaweicloud.com/usermanual-astrozero/zh-cn_image_0000001932885764.png)，可查看接口的参数。 若为公共接口，单击"测试一下"，填写输入参数，单击"执行"，可运行该接口。返回成功响应，表示接口调用成功。 图4测试接口 ![](https://support.huaweicloud.com/usermanual-astrozero/zh-cn_image_0000001960284281.png "点击放大")