API Testing Environment
👉 Testing Environment
⭐ List of Feature ⭐
✅ Heart of API Maker
▸ Almost all the features of API Maker can be operated with just one click through API testing environment.
▸ According to GUI, Will divide API Maker into four main parts.
- Menu-bar
- Top Panel
- Left Panel [Request panel]
- Right Panel [Response panel]
1) Menu-bar
▸ It provides list of all the feature separately, with some meaningful name with icon.
▸ On the right side of menu-bar we found some global feature like, Console log, System log, Test cases, Notes, Git integration with User info & logout menu.
2) Top Panel
▸ Here, user will find all the main category APIs along with the necessary sub-categories.
like, Instance, Custom, System, Third-Party, Events, Scheduler & Database Migration Scripts
▸ From API Testing Environment, the user has the ability to update the schema of any table or collection and also select the Test Hooks feature.
▸ User also has ability to Insert, Update Or Delete APIs from here.
▸ Right side of the top panel we have features
like, Types reloading, Code comparator, code finder, Toggle response panel, Minimize-Maximize window & API Maker Docs.
▸ Finally, we have the Magical Send Button, which is responsible for triggering the API call.
3) Request Panel
Header
- Used to provide additional information for a server to process an API request.
Params
- Options that can be passed with the endpoint to influence the response.
Query params
- The optional key-value pairs that appear after the question mark in the URL.
- Basically, they are utilized to help determine specific content or action based on the data being delivered.
Body
- POST API almost always has to send a request body or it call payroll. But clients don't necessarily need to send request bodies all the time.
Code
- The user has the ability to write java-script code for managing business logic in the inbuilt powerful editor.
Pre Hooks
- Lines of code will be run before the actual API request will be executing.
Post Hooks
- Lines of code will be run after the actual API request is fully executed.
Integrations
- Give the line of code that makes the API request compatible with Multiple language.
4) Response Panel
Response
- Provide the data that is returned from a server when an API request is sent.
- It is typically in the form of a JSON or XML document and contains success, errors, stacks, status Code & data.
- Has inbuilt facility with Wrap Content, Copy Interface, Download response, copy response & clear response.
Logs
- Here, user will find the statements, which user may have printed from their code panel using the g.logger.log statement.
- Which can be more than one.
Docs
- The user can access any API related details or examples directly in this section, with only read permission.
API Docs
- Here, user can write any API related details or information.