Download the PHP package psx/api without Composer

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

Informations about the package api

API

The API component is the reference implementation of the TypeAPI specification. It provides models to describe an REST API and generate based on those models different outputs. You can create those models either by parsing a TypeAPI or OpenAPI specification or by using PHP Attributes. Based on those models it is then possible to generate i.e. client SDKs.

Usage

The root model object is called a Specification which contains Operations and Definitions. Each operation maps to a specific REST API endpoint and the definitions represent the schemas to describe the JSON request or response payload.

Framework

You can use PHP attributes to describe the structure of your endpoints. You can then use the attribute parser (PSX\Api\Parser\Attribute) to automatically generate a specification for your controller. A controller class could then look like:

This would be then enough for the API component to generate either an OpenAPI specification or a client SDK. Note this library only needs the meta information, if you can get those meta information at your framework in another way you can also implement a custom ParserInterface.

Standalone

Beside the framework integration you can use this component also to simply parse existing TypeAPI specification and generate specific output. The following is a simple example how to use the PHP API and how to generate code.

Generator

Client

Markup

Spec

All versions of api with dependencies

PHP Build Version
Package Version
Requires php Version >=8.1
psx/json Version ^3.0
psx/openapi Version ^0.1
psx/schema Version ^6.0
symfony/cache Version ^5.0|^6.0|^7.0
symfony/console Version ^5.0|^6.0|^7.0
symfony/yaml Version ^5.0|^6.0|^7.0
symfony/property-access Version ^5.0|^6.0|^7.0
twig/twig Version ^2.4|^3.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 psx/api contains the following files

Loading the files please wait ....