当前位置:网站首页>APICloud Studio3 API管理与调试使用教程
APICloud Studio3 API管理与调试使用教程
2022-07-05 12:51:00 【白又白888】
简介
面板功能区介绍
根据途中红色数字编号,对应功能如下:
- API、请求变量定义面板切换
- 搜索框与新增按钮
- API列表(列表中的每个文件夹称为一个分类)
- 根据API生成代码
- API详情、从左至右依次为请求method、url与发送请求按钮
- request区域
- response区域
- 变量配置面板
创建API
创建API的方式两种:
- 通过搜索框右侧"+"按钮创建:将鼠标移入按钮会弹出操作面板,点击新建API方法,会弹出编辑API名称弹窗,输入API名称点击"确定"即可在对应的分类下成功创建
- 通过分类右侧"..."按钮创建:选择一个分类后,对应分类右侧会出现"..."按钮,鼠标移入右侧"..."按钮会弹出操作面板,点击新建API方法,会弹出编辑API名称弹窗,输入API名称点击"确定"即可在对应的分类下成功创建
注意事项:
- 在没有分类的情况下,需要先通过搜索框右侧"+"按钮创建分类,然后即可进行正常的API创建流程
- 通过搜索框右侧"+"按钮创建的API会默认创建到当前选中的分类下
删除API/分类
- 删除API:选中要删除的API,对应的API右侧会出现"..."按钮,鼠标移入右侧"...",会弹出相应操作面板,点击删除,会弹出二次确认框以免误操作,点击删除按钮,即可成功删除
- 删除分类:选中要删除的分类,对应的分类右侧会出现"..."按钮,鼠标移入右侧"...",会弹出相应操作面板,点击删除,会弹出二次确认框以免误操作,点击确定删除按钮,即可成功删除。若改分类下存在API,需要先删除所有分类内的API才可以删除该分类
查看/修改API配置
修改API配置信息
选中需要调试或修改的API,在右侧API操作面版可以看到当前API的请求信息、请求参数,点击发送按钮,即可看到当前配置的响应详情
如图为API基础配置:
- 设置请求类型,点击下拉选择相应的请求类型
- 请求地址,输入相应的API请求地址
- 发送请求按钮,当配置完请求参数,点击即可发送请求获得响应
request配置面板
query配置面板,在每一列配置需要的query参数,在发送请求时会以query的形式携带参数
header配置面板,输入相应的配置,会在发送请求时配置到header中
配置body请求体,在相应的请求方式下配置请求体,会根据所选请求类型,在body中携带配置好的参数
response响应面板
主要用于查看API返回数据,可根据自己偏好选择格式化后的数据或是返回的原始数据,右侧下拉选项为格式化的依据
查看response响应的header信息
修改API名称
选中要编辑的API,对应的分类右侧会出现"..."按钮,鼠标移入右侧"...",在弹出的操作面板中选择重命名,输入想要修改的名称点击确定即可
配置变量
点击变量tab按钮,切换到变量操作面板,在面板中以Key,Value的形式配置全局变量,在API调用的时候,使用{Key}的形式即可使用配置好的变量。如下图
注:变量值不能引用变量,如下,是错误的
生成API代码
点击分类列表下面的"生成API代码"按钮,即可根据现有的API在根目录下的apiModel文件夹中自动生成可用代码,其中包含三个文件,分别是apiModel.js、config.js和req.js
- apiModel.js文件:生成API对应的方法,在项目中使用,直接引入该文件,按调试时定义好的API名为函数名称调用即可
如图,①为引用文件,②调用生成的API方法,③结果打印,证明调用成功
- config.js文件:主要保存在API调试时配置的变量信息
- req.js:该文件是对请求方法的封装
边栏推荐
- Taobao, pinduoduo, jd.com, Doudian order & Flag insertion remarks API solution
- Principle and configuration of RSTP protocol
- STM32 and motor development (from architecture diagram to documentation)
- 【服务器数据恢复】某品牌服务器存储raid5数据恢复案例
- Taobao order interface | order flag remarks, may be the most stable and easy-to-use interface
- Laravel document reading notes -mews/captcha use (verification code function)
- SAP UI5 FlexibleColumnLayout 控件介绍
- I'm doing open source in Didi
- 事务的基本特性和隔离级别
- Introduction aux contrôles de la page dynamique SAP ui5
猜你喜欢
[Nacos cloud native] the first step of reading the source code is to start Nacos locally
Taobao short videos are automatically released in batches without manual RPA open source
太方便了,钉钉上就可完成代码发布审批啦!
Pandora IOT development board learning (HAL Library) - Experiment 7 window watchdog experiment (learning notes)
MSTP and eth trunk
Simple page request and parsing cases
Solve Unicode decodeerror: 'GBK' codec can't decode byte 0xa2 in position 107
How can non-technical departments participate in Devops?
Reverse Polish notation
解决uni-app配置页面、tabBar无效问题
随机推荐
函数的默认参数&函数参数的多种方法
碎片化知识管理工具Memos
RHCSA7
谈谈我写作生涯的画图技巧
946. 验证栈序列
[cloud native] event publishing and subscription in Nacos -- observer mode
How to realize batch sending when fishing
Put functions in modules
Introduction aux contrôles de la page dynamique SAP ui5
SAP SEGW 事物码里的 Association 建模方式
Sorry, we can't open xxxxx Docx, because there is a problem with the content (repackaging problem)
Halcon template matching actual code (I)
【服务器数据恢复】某品牌服务器存储raid5数据恢复案例
Realize the addition of all numbers between 1 and number
DNS的原理介绍
What if wechat is mistakenly sealed? Explain the underlying logic of wechat seal in detail
leetcode:221. 最大正方形【dp状态转移的精髓】
A deep long article on the simplification and acceleration of join operation
Hiengine: comparable to the local cloud native memory database engine
How do e-commerce sellers refund in batches?