TYPO3 Logo
RESTful Api for TYPO3
Release: 1.3

Loading data.

  • About the extension
    • Features
    • Limitations
    • Dependencies
    • Contribute
    • Support further development
  • What is a RESTful Api?
  • Installation
  • Screenshots
  • Quick Start
  • Routing & Requests
    • Registering Endpoints
    • Routing by method-name
    • Routing by custom Routes
    • Variables
  • Creating Responses
    • Simple Responses
    • Error Responses
    • Headers and CORS
  • Annotations
    • @Api\Endpoint
    • @Api\Access
    • @Api\Cache
    • @Api\Distiller
    • @Api\Example
    • @Api\Label
    • @Api\IncludeHidden
    • @Api\Json
    • @Api\Route
    • @Api\Upload
    • @Api\Localize
    • Custom Annotations
  • Restricting Access
    • Restricting Access with a custom method
    • Restricting access by sending a 403 response
  • Authentication
    • HTTP Basic Auth
    • JSON Web Token (JWT)
    • Cookies
  • File Uploads
  • Localization & Translation
    • Background infos
  • Get hidden records
  • Kickstarter
  • Documenting your Api
  • Examples & Recipes
    • Example Api Endpoint
    • Rendering Content-Elements
    • Creating Content-Elements (tt_content)
    • Rendering a page
    • Raw Content data
    • Getting settings
    • jQuery
      • Basic requests
      • Authentication
      • Uploading Files
    • Axios
      • Basic requests
      • Authentication
      • Uploading Files
    • Modern JavaScript (ES6+)
      • Basic requests
      • Authentication
      • Uploading Files
    • Legacy JavaScript (IE)
      • Basic requests
      • Authentication
      • Uploading Files
  • Configuration
    • TypoScript Setup
    • YAML Configuration
    • Extension Manager Configuration
    • Frontend-user configuration
  • Known Problems
  • Change log
  • Sitemap

PAGE CONTENTS

  • Annotations
  1. Start
  2. Annotations
View source How to edit Edit on GitHub

Display settings



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\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\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\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
  • Previous
  • Next
  • Contact
  • Issues
  • Repository

Last updated: Sep 15, 2022 09:27

Last rendered: Sep 15, 2022 09:31

  • TYPO3 Theme 4.7.7
  • DRC v3.0.dev28
© Copyright by 99°, David Bascom
  • Legal Notice
  • Privacy Policy
  • Code of Conduct