๐ 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.
- 1) Menu-bar
- 2) Top Panel
- 3) Left Panel [Request panel]
- 4) Right Panel [Response panel]
1) Menu-bar
โธ It provide list of all the feature separately, with some meaningful name with icon.
โธ At 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.
Youtube video link
Websites
API Docs link
https://docs.apimaker.dev/v1/docs/pages/api-testing-page.html