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 JSON endpoints for Badgen and Shields.io, allowing badges to be rendered. The rendering itself takes place at the corresponding services and is not part of this API.

Badgen

  1. Start with the base URL

    https://badgen.net/https/host/endpoint

  2. Replace host with the hostname of this API

    https://badgen.net/https/typo3-badges.dev/endpoint

  3. Select a specific endpoint

    https://badgen.net/https/typo3-badges.dev/badge/launch/downloads/badgen
Shields.io

  1. Start with the base URL

    https://shields.io/endpoint?url=url

  2. Replace url with the URL of this API

    https://shields.io/endpoint?url=http://typo3-badges.dev/endpoint

  3. Select a specific endpoint

    https://shields.io/endpoint?url=http://typo3-badges.dev/badge/launch/downloads/shields

🔥 Endpoints

🤖 API response

Badgen

All endpoints return JSON 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 endpoints return JSON 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.