Annotations

• @Api\Endpoint
  • Mark a class as endpoint for the TYPO3 RestAPi
  • Marking individual Classes as Endpoint
  • Override the path segment / class name
• @Api\Access
  • Restricting access to your endpoint
  • Examples and details?
• @Api\AutoMerge
  • Disabling automatic merging of JSON data with a Model
• @Api\Cache
  • Enable caching for a TYPO3 RestAPi endpoint
  • Handling the cache yourself
• @Api\Distiller
  • Dehydrate the JSON-result before returning it to the client
• @Api\Example
  • Add example data to your documentation
• @Api\Label
  • Add custom label to backend module
• @Api\MaxAge
  • Sends Cache-Control headers for a TYPO3 RestAPi endpoint
  • Handling the Cache-Control header yourself
• @Api\IncludeHidden
  • Retrieve hidden records and relations from the database.
• @Api\Json
  • Control how your TYPO3 RestAPi renders the JSON result
• @Api\Route
  • Use custom routing for your TYPO3 RestAPI endpoint
• @Api\Security\CheckInjections
  • Check incoming request for SQL Injections
  • Globally activating an injection test
• @Api\Security\CheckLocked
  • Check if IP was locked
  • (Un)locking an IP manually
• @Api\Security\MaxRequestsPerMinute
  • Limiting number of requests to an endpoint
• @Api\Upload
  • Control where files are uploaded to in your TYPO3 RestAPi
• @Api\Localize
  • Enable/disable localization (translation) of data
• Custom Annotations
  • Adding custom annotations to your TYPO3 RestApi endpoints