Online API reference

Categories: Development, Documentation Created by François Suter
For a long time there was no online TYPO3 API reference. No longer, please welcome api.typo3.org.

The URL has already been circulating for some time, but an official announcement was lacking. api.typo3.org is the new official online reference for the TYPO3 API. It was set up by Fabien Udriot, with the help of Ingmar Schlecht and Michael Stucki for the server part. It covers the API of:

  • TYPO3 v4 (all versions since 4.3.0)
  • Extbase (all versions since 1.1)
  • Fluid (all versions since 1.1)

ZIP archives can also be downloaded for offline usage.

Technically the API is assembled using both Doxygen and PHP_UML (for Extbase and Fluid). There's an Ant script running every night to retrieve the latest source and rebuild the API for all trunk versions.

FLOW3 and TYPO3 v5 API should be added in the near future, so that api.typo3.org becomes a common resource for everybody.

Fabien is also exploring tools to have a rendering similar to what is done for ExtJS, but the tools are not ready for production use yet.

We hope you will enjoy this new resource. Many thanks to Fabien for taking care of it.