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

Open source ByJG