Download the PHP package tochka-developers/jsonrpc-doc without Composer

On this page you can find all versions of the php package tochka-developers/jsonrpc-doc. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

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 PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • 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.
Please rate this library. Is it a good library?

Example code of tochka-developers/jsonrpc-doc

Informations about the package jsonrpc-doc

JSONRPC Doc (Laravel 5.4-5.5, Lumen 5.4-5.5)

Описание

Генерация документации для JsonRpc-сервера на основе SMD-схемы. Адаптирован для SMD-схемы, возвращаемой оригинальным модулем Tochka-Developers/JsonRpc версии >1.1.11

Установка

Laravel

  1. composer require tochka-developers/jsonrpc-doc

  2. Добавьте Tochka\JsonRpcDoc\ServiceProvider в список сервис-провайдеров в config/app.php:

  3. Опубликуйте конфигурацию и ресурсы:

  4. Настройте роутинг для страниц документации (в App\RouteServiceProvider):

Lumen

  1. composer require tochka-developers/jsonrpc-doc

  2. Зарегистрируйте сервис-провайдер Tochka\JsonRpcDoc\ServiceProvider в bootstrap/app.php:

  3. Скопируйте конфигурацию из пакета (vendor/tochka-developers/jsonrpc-doc/config/jsonrpcdoc.php) в проект (config/jsonrpcdoc.php)
  4. Скопируйте ресурсы из пакета (vendor/tochka-developers/jsonrpc-doc/assets/*) в проект (public/vendor/jsonrpcdoc/*)

  5. Подключите конфигурацию в bootstrap/app.php:

  6. Настройте роутинг для страниц документации в bootstrap/app.php:

Настройка

Отредактируйте конфигурацию jsonrpcdoc. Пакет позволяет выводить документацию сразу для нескольких JsonRpc-серверов. Все используемые сервера должны быть перечислены в списке connections конфигурации пакета.

Имя используемого по умолчанию соединения должно быть прописано в параметре default. Если этот параметр не указан, то в качестве соединения по умолчанию будет использовано первое соединение в списке.

Для использования нескольких документаций для каждой необходимо настроить свою точку входа. Для этого в роутинге при вызове метода \Tochka\JsonRpcDoc\ServiceProvider::route($serviceName) в качестве $serviceName должно быть передано имя используемого соединения. Если имя не передано - будет использовано соединение по умолчанию.

Если пакет tochka-developers/jsonrpc-doc используется вместе с пакетом tochka-developers/jsonrpc, то в качестве url в конфигурации можно указать значение null. В таком случае адрес точки входа JsonRpc-сервера будет взят из конфигурации пакета jsonrpc. Стоит учесть, что это будет работать только в случае использования автоматического роутинга (Ссылка на раздел документации). Также, в случае использования нескольких точек входа - будет использована только первая в списке.

Данная возможность корректно работает только в Laravel. К сожалению, Lumen не поддерживает автоматическое получение имени текущего хоста при запуске из консоли. Вы можете самостоятельно устанавливать переменные $_SERVER['SERVER_NAME'] и $_SERVER['SERVER_PORT'] в своем приложении при инициализации, либо прописать имя хоста в .env:

Такое поведение обеспечивает автоматическую работу без дополнительных настроек в большинстве случаев. Если же вы наблюдаете ошибку типа [ERROR] The host did not return the SMD-scheme. Generating a client is not possible., то попробуйте прописать путь к JsonRpc-серверу в параметре url.

После настройки соединений необходимо получить информацию о сервере (SMD-схему). Для этого выполните команду artisan:

Если в результате вы увидели сообщение [OK] Saving SMD for connection "api" successfull., значит все прошло успешно. Страницы документации после этого должны работать. Модуль сохраняет схему локально и после этого использует для генерации страниц ее. Поэтому для обновления документации необходимо снова выполнить команду jsonrpc:generateDocumentation.

All versions of jsonrpc-doc with dependencies

PHP Build Version
Package Version
Requires php Version >=5.6.4
illuminate/log Version ~5.4
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package tochka-developers/jsonrpc-doc contains the following files

Loading the files please wait ....