Download the PHP package ustal/rapidapi-library without Composer
On this page you can find all versions of the php package ustal/rapidapi-library. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download ustal/rapidapi-library
More information about ustal/rapidapi-library
Files in ustal/rapidapi-library
Package rapidapi-library
Short Description Bundle to work with the API. Validation and parsing according to the metadata
License MIT
Homepage https://github.com/ustal/RapidAPI-library
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 rapidapi-library
Manual
Вызываем менеджер
$manager = $this->get('manager');
Передаем название блока (т.е. какой именно блок будем юзать).
$manager->setBlockName($blockName);
Получаем все валидные данные (согласно метадате)
$validData = $manager->getValidData();
Парсим урл из метадаты и переданный. Заменяем {someVar} на значение из $validData. Если в метадате только куски, например /someAction/. Смотря как делали метадату и может для каждоого Endpoint разные ссылки.
$url = $manager->createFullUrl($validData, $url);
Создаем headers. Обязательно удаляем из $validData переменные, которые передавать не надо (использовались для генерации хедера. Для этого нужна ссылка function createHeaders(&$data). Эту функцию описываем в пакете.
$headers = $manager->createHeaders($validData);
Получаем переменные. Иногда бывает что и для POST запросов надо отправить кучу в URL. Поэтому, используя, urlParam можно разделить параметры на две части.
$urlParams = $manager->getUrlParams();
$bodyParams = $manager->getBodyParams();
$result = $manager->send($url, $urlParams, $bodyParams, $headers);
Custom tags use only in assoc array with "custom" key variable of block and block's arguments.
Blocks
| TagName | Type | Description |
|---|---|---|
| method* | String | One of PUT, POST, GET, DELETE, PATCH etc |
| url* | String | Second part of endpoint /endpointName/action or whole endpoint http://example/com/api/v1/endpointName/action can contain {var}, which will be replaced args by name (in case) or vendorName. Args to replace must be without wrapName tag |
| type | String | multipart or json. Default: json |
| snakeCase | Boolean | True if you want to change all name from exampleVendorName to example_vendor_name. Priority is given to same tag of args. Default: false |
Specific tags (depends on dataType of argument)
Map
| TagName | Type | Description |
|---|---|---|
| divide | Boolean | Use with Map. Divide string from marketPlace to List. |
| toFloat | Boolean | Convert value or list of values into Float. If u divided Map and vendor wants get float values not strings |
| length | Number | Length of float or string param. Set 1 to convert 123.1111 to 123.1 or "123.1111" to "123.1" |
Map (temporary not available)
| lat | String | If divide is true, change list info assocc Array with key = lat value
| lng | String | If divide is true, change list info assocc Array with key = lng value
DatePicker
| TagName | Type | Description |
|---|---|---|
| dateTime.fromFormat | Array | Create date from one of format. Like [Y-m-d\TH:i:s\Z, Y-m-d, timestamp]. |
| dateTime.toFormat | String | Convert data to current format. Like Y-m-d\TH:i:s\Z |
Boolean
| TagName | Type | Description |
|---|---|---|
| toInt | Boolean | Convert true/false into integer 1/0 |
| toString | Boolean | Boolean convert true into "true" and false into "false" Useful if need send var in url. |
Number
String
Select
File
| TagName | Type | Description |
|---|---|---|
| jsonParse | Boolean | парсит файл и вставляет в собранный JSON |
| base64encode | Boolean | закодировать содержимое файла в base64 |
Array
| TagName | Type | Description |
|---|---|---|
| keyValue | Array | Use to create key=>value from array with params key and value. |
| keyValue.key | String | Work only with Arrays. Create key->value array from multi-dimensional array. Set one of the structure parameters as the key. Do the same with the value. |
| keyValue.value | String | Work only with Arrays. Create key->value array from multi-dimensional array. Set one of the structure parameters as the key. Do the same with the value. |
List
| TagName | Type | Description |
|---|---|---|
| toArray | Boolean | Convert string into List (use slug to implode) |
| toString | Boolean | Convert List into String with delimetr slug. Default slug = , |
| slug | String | Implode or explode arrays/strings by this slug. Default slug = , |
| toFloat | Boolean | Convert list of values into Float |
| floatLength? | Number | Length of float param. Set 1 to convert 123.1111 to 123.1 |
All tags (work with all dataTypes)
| TagName | Type | Description |
|---|---|---|
| wrapName | String | используется для вложенности параметров. Создания дерева вложенности переменных. forum.post.comment создаст массивы forum:{post:{comment:{name}}} где name имя переменной, для которой указан wrapName. Соотв не забывать что последнее всегда будет имя переменной. Не стоит дублировать name: commentContent, wrapName: forum.post.comment.commentContent. Будет: forum:{post:{comment:{commentContetn:{commentContent:{value}}}}} |
| vendorName | String | имя аргумента, которое хочет получить вендор. Если не указано, вендор получит имя аргумента в snake case. |
| urlParam | Boolean | параметр используется в ссылке. В ссылке никаких {var=value&foo=bar} не надо. Просто эта переменная (по name или vendorName) будет добавлена со своим значением к ссылке. Использовать с GET параметром не надо. Параметры автоматически будут переданы в url |
| snakeCase | Boolean | true/false. Если стоит true, даже если у блока стоит false, переменная будет преобразована в camel_case |
| complex | Array | сложный параметр. Когда значение одного поля является ключ, другого - значение. Например когда хотят получить {type: email, value: {value}}. Соотв будет только одно поле email и его значение {value}. Но добавится параметр complex: true |
| complex.key | String | имя для ключа. В примере выше это будет "type". Используется когда complex: true |
| complex.value | String | имя для значения. В примере выше это будет "value". Используется когда complex: true |
Пример комплекса
Первый пример (мультипарт) POST https://your-domain-name.example.com/forum/1/category/2/newPost?insertPostSafeAndWhatEver=1&draft=true И ожидает получить title, content, attachment
Второй пример (base64) POST https://your-domain-name.example.com/forum/1/category/2/newPost?insertPostSafeAndWhatEver=1&draft=true И ожидает получить title, content, attachment
Третий пример POST https://your-domain-name.example.com/forum/1/category/2/newPost И ожидает получить JSON такого вида
