Download the PHP package fishyboat21/simple-api without Composer

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

Informations about the package simple-api

SimpleAPI

A minimal, zero-dependency PHP 8.4+ library for building JSON HTTP APIs using a file-per-endpoint pattern. Each endpoint is a single PHP file in public/api/ — no complex routing, no route cache, no code generation. Just create a file and it's live.

Requirements

Installation

Quick Start

1. Create your first endpoint

public/api/health.php

2. Start the server

3. Test it


Clean URLs

Enable clean URLs without the .php extension by placing this .htaccess in your public/ directory:

With the rewrite rule:


Creating Endpoints

Single-method endpoint

Multi-method endpoint

Register multiple HTTP method handlers on the same file:

Supported methods: get(), post(), put(), delete(), patch().


Request Handling

The Request object provides access to every part of the incoming request:


Response Helpers

JSON response format


CORS Configuration

CORS is configurable per-endpoint or globally with safe defaults (allow all origins, common methods).

Note: Using allowedOrigins: ['*'] together with allowCredentials: true will throw a RuntimeException — the CORS spec forbids this combination.


Error Handling & Logging

Error responses

Condition Status Body
Method not allowed 405 {"status":405,"message":"Method Not Allowed"} + Allow header
Unhandled exception 500 {"status":500,"message":"Internal Server Error"}
Custom HttpException varies Status from exception, safe message exposed

Security: Unhandled exceptions return a generic "Internal Server Error" message. The real error is logged server-side, never exposed to the client.

Attaching a logger

Custom HTTP exceptions in handlers

Create your own exception types:


Complete Example

public/api/task.php


Performance


License

MIT


All versions of simple-api with dependencies

PHP Build Version
Package Version
Requires php Version >=8.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 fishyboat21/simple-api contains the following files

Loading the files please wait ...