Welcome to the documentation of Mockado! Here you’ll find detailed information and orientation on how to use our services to simulate and test dynamic APIs.
To access Mockado, simply create a free account and have access to 5 APIs with 50 resources and 100 requests per minute. For unlimited use and resources, get the premium plan for just $8,90 monthly.
Go to our Login area and authenticate Github to create your account
API stands for Application Programming Interface and consists of a set of rules, protocols and tools that enable communication and interaction between different softwares, systems or services.
In a technical way, an API defines how softwares components should communicate. It establishes the standards and methods that an application or system can use to access and interact with the functionalities and data of another system, whether it be an operating system, a web service, a database, or any other application.
Generally APIs are documented so that developers know how to use them correctly.
In summary, an API is like a contract that defines how different softwares can communicate, allowing integration between systems.
After the authentication, the access to manager Mockado is released. On the main list is an example API named “HelloWord”.
The list has the name, context (endpoint), creation time and day.
To present the general functionalities the “HelloWord’ API will be used as an example.
The button “Create a mock” shows the required fields.
Inform the API name, that can also have a description.
Select on the HTTP verb list the desired features.
Inform the target and create mock content (API payload). Click on the save button.
The API now is created and it’s on the API list.
By clicking on the desired API name, the mock API features will be shown: overview, runtime, resources, API definition and environments.
The first feature is Overview, with the general resources. It’s possible to summon up the API from the endpoint.
The feature “Runtime Configurations” shows a function of the cache to the API.
After activating this function it’s necessary to inform the storage time of the cache, by default 300 seconds is introduced.
This feature allows visualization and editing of the created resources and makes the implementation of additional resources possible.
By clicking on the feature there will be a list of already existent resources.
When changing the content, click save!
To add a new resource, click on the HTTP verb list, select one or more verbs, inform the patch and click on the “+” button.
To create the content of the created resource, follow the editing.
Important: when it’s necessary to have more than one resource with the same verb, the patch has to be different. By creating a new resource with the same verb, adding the patch of the same target and saving, the update will be done with the already known resource.
To delete a resource, click on the trash icon.
The feature API Definition presents the swagger with the yaml OpenAPI 3.1 definition of the API, and the download can be done.
This feature shows a graphic with the quantity of the last 30 days requests.
In user edit feature is the access to do the logout and the billing.
The manage billing will direct to the Stripe panel.