Download the PHP package exequiellares/mock-api without Composer
On this page you can find all versions of the php package exequiellares/mock-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download exequiellares/mock-api
More information about exequiellares/mock-api
Files in exequiellares/mock-api
Package mock-api
Short Description Magento 2 module to add mock api feature
License GPL-3.0-or-later
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package mock-api
Magento 2 Mock API
This module will add a frontend controller into the current Magento store that will simulate an API.
This is useful to test new features that requires external API connections.
The module adds two public controllers:
- POST {domain}/mockapi/
- GET {domain}/mockapi/
The controller response should return JSON data that will be configurable.
The controller request should receive a Bearer token to validate the request. The token is configurable.
The module allow to define a set of fields that the body must have in order to validate request and simulate Bad Request responses.
Allow to log into custom file received request.
Install
Settings
The module configuration is available at:
Stores > Configuration > Advanced > Developer > Mock API
Options
- Enabled: enable or disable the module
- Enable Log: enable or disable the log of received requests
- Validate Token: enable or disable the validation of the token. If disabled, the token will be ignored.
- Token: Token to validate the request. If empty, the token will be ignored.
- GET display request on response: If enabled, the GET request will return the request body on the response.
- POST display request on response: If enabled, the POST request will return the request body on the response.
- Validate Request Fields: If enabled, the request body will be validated against the fields defined on the next option.
- Fields to Validate: List of fields to validate. The fields must be separated by a comma. Example: id,currency,discount,total,shipping,name,address,city,state,postcode,country,amount,method
- Force Error Response: If enabled, the response will be an error response.
- Error Message: Error message to return on the response. If empty, the default message will be used.
- Success Message: Success message to return on the response. If empty, the default message will be used.
Example usage:
GET request
POST request
Logger
Received request are logged into: var/log/mock_api.log
Next features
- Allow to configure body response on GET request
- Allow to configure body response on POST request
