Download the PHP package phpsoftbox/api without Composer

On this page you can find all versions of the php package phpsoftbox/api. 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 phpsoftbox/api

Informations about the package api

PhpSoftBox API

Компонент описывает HTTP API, его публичные ошибки и правила выбора опубликованной версии запроса. Он не извлекает версию из URL и не зависит от структуры routes проекта.

Версии

Проект объявляет опубликованные версии enum-ом:

Policy содержит точный список и default:

Отсутствующий или пустой header выбирает default. Синтаксически корректная, но неопубликованная версия отклоняется: промежуточный диапазон не поддерживается.

Middleware сохраняет ApiRequestVersionInterface в request attributes и добавляет selected/minimum/latest headers и Vary в response.

Ошибки

ApiErrorCatalog объединяет общие и специфичные определения и отклоняет конфликтующие codes:

Endpoint может ссылаться только на зарегистрированные определения через #[ApiErrors(...)]. Перед генерацией документации ссылки следует проверить через ApiErrorCatalog::requireAll().

Для JSON runtime responses phpsoftbox/application предоставляет CodedHttpException. Предметные исключения преобразуются в него через ExceptionMapperRegistry; публичные status, code, title и message берутся из ApiErrorDefinition.

Если phpsoftbox/application установлен, готовый ApiVersionExceptionMapper преобразует ошибки negotiation в CodedHttpException, добавляя minimum/latest headers и Vary. Application указан как optional integration dependency: core versioning остаётся PSR-only.

Подключение в проекте

  1. Объявите enum опубликованных версий и policy.
  2. Соберите ApiDescription, зарегистрировав common и project-specific errors.
  3. Добавьте ApiVersionMiddleware только на versioned route group.
  4. Зарегистрируйте ApiVersionExceptionMapper в application ExceptionMapperRegistry.
  5. Передавайте выбранную версию в Action как ApiRequestVersionInterface либо проектный наследник AbstractApiRequestVersion с именованными feature gates.

Major в URL не входит в этот контракт. /v1, namespace контроллеров и набор маршрутов остаются проектным routing-соглашением; опубликованную полную версию определяет только policy подключённого API.

Auth audience

Если приложение выпускает отдельные credentials для нескольких API, стабильный ApiDescription::id следует использовать как credential audience. Например, credential с audience catalog принимается route group API catalog, но не API warehouse.

API version и major в URL в audience не входят. Компонент Api только задаёт идентификатор; выдача, хранение и проверка credentials остаются ответственностью phpsoftbox/auth и проектного middleware.

Внешнему проекту после обновления также нужно учесть framework-изменения:

All versions of api with dependencies

PHP Build Version
Package Version
Requires php Version ^8.5
psr/http-message Version ^2.0
psr/http-server-handler Version ^1.0
psr/http-server-middleware Version ^1.0
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 phpsoftbox/api contains the following files

Loading the files please wait ...