Skip to content

Latest commit

 

History

History
38 lines (33 loc) · 945 Bytes

README.md

File metadata and controls

38 lines (33 loc) · 945 Bytes

APIphany

PHP API package

Mission Statement

  • Translate legacy code into APIs
  • Annotations/Decorators (Doc Block Hints) to define general configuration
  • Easy APIs with minimal config
  • Pluggable & extendable
  • Composer package (Not a framework)
  • PSR-0 to PSR-7 compliant
  • Encourage code documentation
  • Encourage best pratice
  • PHP 5.4+ support

Required Components

  • Routing
  • Documentation (browsable, auto-generated)
  • Versioning (header based)
  • Logging (with Monolog)
  • Authentication/Authorisation (possibly using Sentinel)
  • Validation
  • Caching
  • Throttling
  • Exceptions (handle returning correct status codes with custom messages etc)

Return types

  • JSON
  • XML
  • YAML
  • HTTP (for documentation)

Backends

  • Eloquent Models
  • Proxy
  • Methods/Functions

Notes