Download the PHP package tnapf/api-skeleton without Composer

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

Informations about the package api-skeleton

Tnapf/ApiSkeleton

Setup

composer create-project tnapf/api-skeleton

Bootstrapping

Just create a new file inside Bootstrap and then require it in Bootstrap/requires.php

Routing

Creating an endpoint

First create a class that extends Tnapf\Router\Interfaces\ControllerInterface inside App\Controllers and add the #[Route] attribute to the class.

By default, each URI is prefixed with /api so the route below can be access by /api/ping. You can change this by setting the API_PREFIX constant in Bootstrap/environment.php.

Note: You can set the priority of the route to determine the order in which routes are loaded. The default priority is 0.

Catching exceptions

First create a class that extends Tnapf\Router\Interfaces\ControllerInterface inside App\Catchers and add the #[Catcher] attribute to the class.

Note: You can set the priority of the catcher to determine the order in which catchers are loaded. The default priority is 0.

Creating responses

There is a helper class named ApiResponse that can be used to create responses.

Unit Testing

Creating a test

Create a class that extends Tests\ApiTestCase inside App\Tests. This should bootstrap the application into the testing environment, so you can test your endpoints. You'll also get some additional helper methods. See Tests\PingTest.php for an example.

Running tests

composer tests or composer tests:coverage to generate a coverage report.

Dependencies

Dev Dependencies

All versions of api-skeleton with dependencies

PHP Build Version
Package Version
Requires php Version ^8.1
tnapf/env Version ^v1.1.1
tnapf/router Version ^v6.0.0
commandstring/utils Version ^1.7
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 tnapf/api-skeleton contains the following files

Loading the files please wait ...