TYPO3 Badges
A beautiful eye-catcher for your extension documentations.
TER extensions only
Please note: Only TYPO3 extensions published at TYPO3 extension repository (TER) are supported, because all extension metadata are fetched from TER REST API.
🚀 Usage
This API provides endpoints for Badgen and Shields.io, allowing badges to be rendered.
Each endpoint supports the
svg
format with the rendered SVG badge and the
json
format with JSON data for external badge providers.
🔥 Endpoints
-
GET
Get JSON data for Composer name./badge/{extension}/composer/{provider}.{_format}.. image:: https://typo3-badges.dev/badge/static_info_tables_da/composer/badgen.svg
:alt: Composer<img alt="Composer" src="https://typo3-badges.dev/badge/static_info_tables_da/composer/badgen.svg">
.. image:: https://typo3-badges.dev/badge/static_info_tables_da/composer/shields.svg
:alt: Composer<img alt="Composer" src="https://typo3-badges.dev/badge/static_info_tables_da/composer/shields.svg">
-
GET
Get JSON data for total extension downloads./badge/{extension}/downloads/{provider}.{_format}.. image:: https://typo3-badges.dev/badge/static_info_tables_da/downloads/badgen.svg
:alt: Total downloads<img alt="Total downloads" src="https://typo3-badges.dev/badge/static_info_tables_da/downloads/badgen.svg">
.. image:: https://typo3-badges.dev/badge/static_info_tables_da/downloads/shields.svg
:alt: Total downloads<img alt="Total downloads" src="https://typo3-badges.dev/badge/static_info_tables_da/downloads/shields.svg">
-
GET
Get JSON data for extension key./badge/{extension}/extension/{provider}.{_format}.. image:: https://typo3-badges.dev/badge/static_info_tables_da/extension/badgen.svg
:alt: TYPO3 extension<img alt="TYPO3 extension" src="https://typo3-badges.dev/badge/static_info_tables_da/extension/badgen.svg">
.. image:: https://typo3-badges.dev/badge/static_info_tables_da/extension/shields.svg
:alt: TYPO3 extension<img alt="TYPO3 extension" src="https://typo3-badges.dev/badge/static_info_tables_da/extension/shields.svg">
-
GET
Get JSON data for extension stability./badge/{extension}/stability/{provider}.{_format}.. image:: https://typo3-badges.dev/badge/static_info_tables_da/stability/badgen.svg
:alt: Stability<img alt="Stability" src="https://typo3-badges.dev/badge/static_info_tables_da/stability/badgen.svg">
.. image:: https://typo3-badges.dev/badge/static_info_tables_da/stability/shields.svg
:alt: Stability<img alt="Stability" src="https://typo3-badges.dev/badge/static_info_tables_da/stability/shields.svg">
-
GET
Get JSON data for supported TYPO3 versions./badge/{extension}/typo3/{provider}.{_format}.. image:: https://typo3-badges.dev/badge/static_info_tables_da/typo3/badgen.svg
:alt: TYPO3 versions<img alt="TYPO3 versions" src="https://typo3-badges.dev/badge/static_info_tables_da/typo3/badgen.svg">
.. image:: https://typo3-badges.dev/badge/static_info_tables_da/typo3/shields.svg
:alt: TYPO3 versions<img alt="TYPO3 versions" src="https://typo3-badges.dev/badge/static_info_tables_da/typo3/shields.svg">
-
GET
Get JSON data for extension verification state./badge/{extension}/verified/{provider}.{_format}.. image:: https://typo3-badges.dev/badge/static_info_tables_da/verified/badgen.svg
:alt: Verified state<img alt="Verified state" src="https://typo3-badges.dev/badge/static_info_tables_da/verified/badgen.svg">
.. image:: https://typo3-badges.dev/badge/static_info_tables_da/verified/shields.svg
:alt: Verified state<img alt="Verified state" src="https://typo3-badges.dev/badge/static_info_tables_da/verified/shields.svg">
-
GET
Get JSON data for current extension version./badge/{extension}/version/{provider}.{_format}.. image:: https://typo3-badges.dev/badge/static_info_tables_da/version/badgen.svg
:alt: Latest version<img alt="Latest version" src="https://typo3-badges.dev/badge/static_info_tables_da/version/badgen.svg">
.. image:: https://typo3-badges.dev/badge/static_info_tables_da/version/shields.svg
:alt: Latest version<img alt="Latest version" src="https://typo3-badges.dev/badge/static_info_tables_da/version/shields.svg">
-
GET
Get JSON data for a generic TYPO3 badge./badge/typo3/{provider}.{_format}.. image:: https://typo3-badges.dev/badge/typo3/badgen.svg
:alt: TYPO3<img alt="TYPO3" src="https://typo3-badges.dev/badge/typo3/badgen.svg">
.. image:: https://typo3-badges.dev/badge/typo3/shields.svg
:alt: TYPO3<img alt="TYPO3" src="https://typo3-badges.dev/badge/typo3/shields.svg">
🤖 JSON response schema
Badgen
All JSON endpoints return objects to be processed by Badgen.
{
"subject": "typo3",
"status": "inspiring people to share",
"color": "orange"
}Take a look at the official documentation of Badgen to get an overview about how JSON data is processed.
Shields.io
All JSON endpoints return objects to be processed by Shields.io.
{
"schemaVersion": 1,
"label": "typo3",
"message": "inspiring people to share",
"color": "orange",
"isError": false,
"namedLogo": "typo3"
}Take a look at the official documentation of Shields.io to get an overview about how JSON data is processed. There you will also find ways to override the configuration sent by the API.
🤔 Anything else?
If you are missing something, feel free to create an issue or submit a pull request.