byjg/restserver

Create RESTFull services with different and customizable output handlers (JSON, XML, Html, etc.). Auto-Generate routes from swagger.json definition.

5.0.3 2025-06-18 16:54 UTC

Requires

• php: >=8.1 <8.4
• ext-json: *
• byjg/cache-engine: ^5.0
• byjg/jwt-wrapper: ^5.0
• byjg/serializer: ^5.0
• byjg/singleton-pattern: ^5.0
• byjg/webrequest: ^5.0
• filp/whoops: ^2.14
• nikic/fast-route: v1.3.*
• psr/log: ^1.0|^2.0|^3.0

Requires (Dev)

• monolog/monolog: ^2.9|^3.4
• phpunit/phpunit: 5.7.*|7.4.*|^9.6
• vimeo/psalm: ^5.9

Suggests

• ext-fileinfo: *

MIT

README

Create RESTFull services with different and customizable output handlers (JSON, XML, Html, etc.). Auto-Generate routes from swagger.json definition.

Documentation

Setup:

• Set up the RestServer

Creating and customizing routes:

• Defining Route Names
• Create Routes using Closures
• Create Routes Manually
• Create Routes using PHP Attributes
• Auto-Generate from an OpenApi definition (hot)

Processing the request and output the response:

• HttpRequest and HttpResponse object
• File Uploads

Advanced:

• Middleware
  • CORS Support
  • Static Server Files
  • JWT Authentication
• Error Handler
• Intercepting the Request
• Output Processors
• Caching Routes

Additional topics:

• Mock Testing
• Route Metadata
• Content Negotiation
• Custom HTTP Status Codes
• CSV Endpoint Example
• PSR-7 Adapters

Installation

composer require "byjg/restserver"

Dependencies

flowchart TD
    byjg/restserver --> byjg/serializer
    byjg/restserver --> byjg/singleton-pattern
    byjg/restserver --> byjg/cache-engine
    byjg/restserver --> byjg/webrequest
    byjg/restserver --> byjg/jwt-wrapper

Loading

Open source ByJG