Apicloud studio3 API management and debugging tutorial

brief introduction

Introduction to panel function area

Number according to the red number on the way , The corresponding functions are as follows ：

1. API、 Request variable definition panel switch
2. Search box and new button
3. API list （ Each folder in the list is called a category ）
4. according to API The generated code
5. API details 、 From left to right are requests method、url And send request button
6. request Area
7. response Area
8. Variable configuration panel

establish API

establish API There are two ways ：

1. Through the right side of the search box "+" Button to create ： Move the mouse into the button to pop up the operation panel , Click New API Method , The editor will pop up API Name popup , Input API Name Click " determine " You can successfully create under the corresponding category

1. Through the classification on the right "..." Button to create ： Select a category , On the right side of the corresponding category "..." Button , Move the mouse to the right "..." The button will pop up the operation panel , Click New API Method , The editor will pop up API Name popup , Input API Name Click " determine " You can successfully create under the corresponding category

matters needing attention ：

1. Without classification , You need to go through the right side of the search box first "+" Button to create a classification , Then, normal API Create a process

1. Through the right side of the search box "+" Button API It will be created under the currently selected category by default

Delete API/ classification

• Delete API： Select the one you want to delete API, Corresponding API It will appear on the right "..." Button , Move the mouse to the right "...", The corresponding operation panel will pop up , Click delete , A second confirmation box will pop up to avoid misoperation , Click the delete button , Can be deleted successfully
• Delete category ： Select the category to delete , The corresponding category will appear on the right "..." Button , Move the mouse to the right "...", The corresponding operation panel will pop up , Click delete , A second confirmation box will pop up to avoid misoperation , Click OK to delete , Can be deleted successfully . If it exists under the changed classification API, You need to delete all categories API You can delete this category

see / modify API To configure

modify API Configuration information

Select the one that needs to be debugged or modified API, On the right side API The operation panel can see the current API Request information for 、 Request parameters , Click Send button , You can see the response details of the current configuration

Pictured here API Basic configuration ：

1. Set request type , Click the drop-down to select the corresponding request type
2. Request address , Enter the corresponding API Request address
3. Send request button , When the request parameters are configured , Click to send the request and get the response

request Configuration panel

query Configuration panel , Configure the required in each column query Parameters , The request will be sent with query Carry parameters in the form of

header Configuration panel , Enter the corresponding configuration , It will be configured to header in

To configure body Request body , Configure the request body in the corresponding request mode , According to the selected request type , stay body Carry the configured parameters in

response Response panel

It is mainly used to view API Return the data , You can choose the formatted data or the returned original data according to your preferences , The drop-down options on the right are the basis for formatting

see response Responsive header Information

modify API name

Select the API, The corresponding category will appear on the right "..." Button , Move the mouse to the right "...", Select Rename in the pop-up operation panel , Enter the name you want to modify and click ok

Configuration variables

Click variables tab Button , Switch to the variable operation panel , In the panel, click Key,Value Configure global variables in the form of , stay API When called , Use {Key} You can use the configured variables in the form of . Here's the picture

notes ： Variable values cannot reference variables , as follows , It's wrong.

Generate API Code

Click " Generate API Code " Button , According to the existing API In the root directory apiModel Automatically generate available code in the folder , It contains three files , Namely apiModel.js、config.js and req.js

• apiModel.js file ： Generate API Corresponding method , Used in projects , Import the file directly , As defined during debugging API Call the function name

Pictured ,① For reference ,② Call generated API Method ,③ Results the print , Prove successful call

• config.js file ： Mainly preserved in API Variable information configured during debugging
• req.js： This file is the encapsulation of the request method