.. every .rst file should include Includes.txt .. use correct path! .. include:: Includes.txt .. Every manual should have a start label for cross-referencing to .. start page. Do not remove this! .. _start: ============================================================= RESTful API for Typo3 (nnrestapi by 99°) ============================================================= Everything you need to create a "Representational State Transfer Application Programming Interface" in TYPO3. .. container:: row m-0 p-0 .. container:: col-12 col-md-6 pl-0 pr-3 py-3 m-0 .. container:: card px-0 h-100 .. rst-class:: card-header h4 .. rubric:: :ref:`➔ Screenshots ` .. container:: card-body See what you get. Screenshots of the front- and backend. .. container:: col-12 col-md-6 pl-0 pr-3 py-3 m-0 .. container:: card px-0 h-100 .. rst-class:: card-header h4 .. rubric:: :ref:`★ Features ` .. container:: card-body :ref:`Motivation ` and overview of the :ref:`main features `. .. container:: col-12 col-md-6 pl-0 pr-3 py-3 m-0 .. container:: card px-0 h-100 .. rst-class:: card-header h4 .. rubric:: :ref:`⚑ Installation ` .. container:: card-body How to :ref:`install ` the extension. How to set up an Api in 5 minutes using this :ref:`quick-start `. .. container:: col-12 col-md-6 pl-0 pr-3 py-3 m-0 .. container:: card px-0 h-100 .. rst-class:: card-header h4 .. rubric:: :ref:`⌘ Routing ` .. container:: card-body Routing requests / URLs to your classes and methods (endpoints). .. container:: col-12 col-md-6 pl-0 pr-3 py-3 m-0 .. container:: card px-0 h-100 .. rst-class:: card-header h4 .. rubric:: :ref:`↹ Responses ` .. container:: card-body How to create a response and convert Models, ObjectStorages and FileReferences to JSON (by doing nothing ;) .. container:: col-12 col-md-6 pl-0 pr-3 py-3 m-0 .. container:: card px-0 h-100 .. rst-class:: card-header h4 .. rubric:: :ref:`@ Annotations ` .. container:: card-body Configure almost anything using Annotations, directly at your method. .. container:: col-12 col-md-6 pl-0 pr-3 py-3 m-0 .. container:: card px-0 h-100 .. rst-class:: card-header h4 .. rubric:: :ref:`✜ Access ` .. container:: card-body How to only allow certain users to access your Api. .. container:: col-12 col-md-6 pl-0 pr-3 py-3 m-0 .. container:: card px-0 h-100 .. rst-class:: card-header h4 .. rubric:: :ref:`⊛ Authentication ` .. container:: card-body How to authenticate using :ref:`HTTP Basic Auth `, :ref:`JSON Web Tokens ` and :ref:`Cookies `. .. container:: col-12 col-md-6 pl-0 pr-3 py-3 m-0 .. container:: card px-0 h-100 .. rst-class:: card-header h4 .. rubric:: :ref:`❖ Uploading Files ` .. container:: card-body How to upload files from the frontend and create FileReferences (FAL) in a single request using multipart/form-data. .. container:: col-12 col-md-6 pl-0 pr-3 py-3 m-0 .. container:: card px-0 h-100 .. rst-class:: card-header h4 .. rubric:: :ref:`❉ Localization ` .. container:: card-body Retrieving translated (localized) data .. container:: col-12 col-md-6 pl-0 pr-3 py-3 m-0 .. container:: card px-0 h-100 .. rst-class:: card-header h4 .. rubric:: :ref:`✿ Kickstarter ` .. container:: card-body Create a namespaced extension with a single click. .. container:: col-12 col-md-6 pl-0 pr-3 py-3 m-0 .. container:: card px-0 h-100 .. rst-class:: card-header h4 .. rubric:: :ref:`❂ Writing documentation ` .. container:: card-body How to create a beautiful documentation of your endpoints. Without leaving your code editor. .. container:: col-12 col-md-6 pl-0 pr-3 py-3 m-0 .. container:: card px-0 h-100 .. rst-class:: card-header h4 .. rubric:: :ref:`✲ Examples ` .. container:: card-body Examples for the backend, examples for the frontend. Examples in VanillaJS, jQuery, axios. And examples on CodePen. .. container:: col-12 col-md-6 pl-0 pr-3 py-3 m-0 .. container:: card px-0 h-100 .. rst-class:: card-header h4 .. rubric:: :ref:`⨳ Configuration ` .. container:: card-body Overview of the :ref:`TypoScript setup ` and configuration you can set in :ref:`yaml ` Is the extension free? ----------------------- **Yes**, :ref:`but ...! ` License ----------------------- This extension documentation is published under the `CC BY-NC-SA 4.0 `__ (Creative Commons) license Authors ----------------------- :Version: |release| :Language: en :Authors: `www.99grad.de `__, David Bascom :Email: info@99grad.de .. toctree:: :hidden: :maxdepth: 3 About/Index Introduction/Index Installation/Index Screenshots/Index Quickstart/Index Requests/Index Responses/Index Annotations/Index Access/Index Authentication/Index FileUploads/Index Localization/Index HiddenRecords/Index Kickstarter/Index WritingDoc/Index Examples/Index Configuration/Index KnownProblems/Index Changelog/Index Sitemap