新手入门01-创建应用
优采云 发布时间: 2020-08-20 14:28新手入门01-创建应用
「深度学习福利」大神带你进阶工程师,立即查看>>>
新手入门01-创建应用
于 2020-08-05发布在 VirAPI官网
新手入门系列介绍文章:《新手入门01-创建应用》、《新手入门02-新建插口》、《新手入门03-接口测试与使用》、《新手入门04-应用中级管理》。
本篇文章将详尽的为您介绍VirAPI创建应用的整个过程。按照页面上的提示与描述基本可以直接上手;不过其中可能有些细节可以留心一下。
创建VirAPI应用很简单,登录VirAPI控制台,进入【创建应用页】()。应用创建页如下图:
注意:每个新注册的帐号系统就会默认生成一个“平台惟一ID”,这个ID将作为您的身分标示以及您创建的所有应用与插口的恳求标记。如上图所示,应用API网址为,其中vir_gitee115198f3h87ge即为当前演示帐号的身分ID,之后的所有恳求虚拟数据插口都是通过该ID来分辨。由于系统初始默认ID都是随机生成,您可抵达【*敏*感*词*页】()进行编辑更改,不过请注意,此ID仅可更改一次,修改保存成功后将难以再度编辑。
应用名&应用标示
根据创建应用表单的提示,输入应用名,应用名支持2至36个中英文或特殊符号。
填写完应用名后系统将手动依照应用名生成一个“应用标示”,您可以按照须要进行重置更改;应用标示目前只支持2至20个大小写字母、数字、下划线(_)、中划线(-)、英文句号(.),且同一帐号下应用标示必须惟一。该应用标示将作为虚拟数据插口的应用标记,且创建保存后不可再更改。
应用描述&应用图标
该两项都是可选的编辑项,您可依照须要进行处理。
此时页面大约如下:
应用中级设置
如上图右下角红框标记有一个“显示中级设置”,点击该链接将可见应用的中级配置选项。一般采取默认即可,无需再更改中级配置;不过难免有些情况是须要依照自己的业务场景的不同而须要调整的。VirAPI提供的应用中级设置如下图:
现在来详尽介绍这种中级配置:
请求验证规则
即恳求应用下虚拟数据生成插口时,用于验证恳求权限的方法。当前提供三种验证规则。
自定义恳求响应结构
即定义该应用所有恳求返回的统一规范的响应数据结构。
可能看起来不太理解,那么结合下边的响应数据事例都会马上明白了:
最终结构示例(请求成功)
{
"code": 200,
"message": "Succeed",
"data": {
"id": 1,
"name": "virapi"
}
}
最终结构示例(请求失败):
{
"code": 1000,
"message": "Failed"
}
这下是不是都理解了?很简单。
全部编辑完后,记得点击页面下方的“创建应用”按钮。创建成功后即会手动跳转到该应用的详情页面。
若后期须要对该应用的基本资料或中级设置进行更改编辑,则可点击该应用的详情页面的一侧菜单栏【管理】->【应用设置】进行设置更改。
若您创建应用时未更改自己的默认“平台惟一ID”,在创建应用后再更改的“平台惟一ID”,则该应用API网址中的用户标记也将立刻更新,且之前的链接将失效。
至此,VirAPI怎样创建应用就介绍完了。如在使用过程中有碰到哪些问题也欢迎你们通过Gitter与我们沟通和联系。