Open Data App Generic

Die Open Data App generic ist als Startpunkt für eigene ODAs konzipiert. Sie ist Vorlage und Musterbeispiel einer ODA und erfüllt die ODA-Spezifikation. Der aktuelle Referenzstand ist Version 1.1.0 vom 10.07.2026.

oda-generic ist eine Empfehlung, nicht die einzige denkbare ODAS-Implementierung. Wer die Vorlage nutzt, bekommt ein fertiges Grundgerüst mit Header, Navigation, Inhaltsbereich, Footer und Konfigurationsladung und profitiert von einem einheitlichen Aufbau und leichterer Prüfung.

Inhalt

Dateien und Verzeichnisaufbau

Die Vorlage ist klar strukturiert. Nachfolgend die Übersicht der wichtigsten Dateien und Verzeichnisse:

oda-generic/
├── app/                        # Frontend-Anwendung
│   ├── app-base.js             # Basis-JavaScript: Routing, Konfigurationsladung, Fehleranzeige (nicht ändern)
│   ├── app-base.css            # Basis-CSS für generelle Styles (nicht ändern)
│   ├── app.js                  # Haupt-JavaScript: hier kommt der eigene App-Code hinein
│   ├── app.css                 # App-spezifisches CSS
│   ├── index.html              # Grundgerüst; der Inhalt wird dynamisch eingefügt (nicht ändern)
│   ├── favicon.png             # Favicon der Anwendung
│   └── logo_ondics.png         # Beispiel-Logo
├── assets/                     # Zusätzliche Assets
│   ├── odas-app-icon.svg       # Icon der App für den ODAS
│   ├── Desktop_Screenshot.png  # Screenshot der Desktop-Ansicht
│   ├── Mobile_Screenshot.png   # Screenshot der Mobile-Ansicht
│   ├── branding.css            # Branding-Basisdatei
│   └── schema.json             # Frictionless-Beispielschema; pro App durch das echte Datenmodell ersetzen
├── odas-config/                # Lokale Konfiguration
│   └── config.json             # Testkonfiguration für die lokale Entwicklung
├── .vscode/                    # VS-Code-Einstellungen
│   └── settings.json           # u. a. Port für die Live Server Extension
├── app-package.json            # ODAS-Metadaten; hieraus erzeugt der ODAS die Instanz-Konfiguration
├── CHANGELOG.md                # Änderungsprotokoll der App
├── README.md                   # Dokumentation und Einführung zur App
├── Dockerfile                  # Docker-Build der App (Nginx)
├── docker-compose.yml          # Konfiguration für Docker Compose
├── nginx.conf                  # Nginx-Konfigurationsdatei
└── Makefile                    # Build- und Wartungsbefehle, u. a. make zip

Nach make zip entsteht zusätzlich eine ZIP-Datei für die Auslieferung an den ODAS. Sie enthält app/, assets/, app-package.json und CHANGELOG.md.

Grundfunktionen

Die Open Data App “generic” bietet in Version 1.1.0 folgende Basisfunktionen:

Wie und wohin schreibe ich meinen Code?

Empfohlenes Grundmuster:

function app(configdata = {}, enclosingHtmlDivElement) {
  enclosingHtmlDivElement.innerHTML = `
    <section class="container py-3">
      <h2>${configdata.titel || "Open Data App"}</h2>
      <p>Hier wird der App-Inhalt gerendert.</p>
    </section>
  `;
}

function addToHead() {}

Konfiguration

Produktiv erzeugt der ODAS die Konfiguration aus app-package.json und den Angaben der App-Instanz. Beim Anlegen einer App-Instanz übernimmt der ODAS zunächst die default-Werte und die in der app-package.json eingetragenen Werte; der Portalbetreiber passt sie danach über das Konfigurationsformular an. Lokal wird diese Konfiguration über odas-config/config.json gespiegelt. Dort können z.B. Titel, Footer oder der Link zu den Daten aus dem Open Data Portal zum Testen eingetragen werden.

Empfohlen ist:

Felder mit format.typ: "markdown" (z.B. beschreibung, kontakt, impressum, datenschutz) werden in Markdown verfasst; ODAS wandelt das Markdown vor der Auslieferung der Konfiguration in HTML um, das die Vorlage unverändert rendert. Im lokalen odas-config/config.json stehen diese Inhalte als HTML. Details stehen in der ODA-Spezifikation.

Lokale Entwicklung

Für schnelle Frontend-Iteration wird VS Code Live Server aus der Projektwurzel empfohlen:

{
  "liveServer.settings.host": "127.0.0.1",
  "liveServer.settings.root": "/",
  "liveServer.settings.file": "app/index.html"
}

Dann die App unter http://127.0.0.1:<live-server-port>/app/ öffnen. Live Server nutzt standardmäßig Port 5500; Projekte können in .vscode/settings.json einen anderen Port festlegen.

Läuft die App unter 127.0.0.1 oder localhost, lädt getConfigUrl() in app/app-base.js automatisch die lokale ../odas-config/config.json. Ein manuelles Umschalten ist dafür nicht nötig.

Docker bleibt als Alternative verfügbar:

make build
make up

CORS und Proxy

Wenn eine Datenquelle direkte Browserabrufe blockiert, kann eine App den ODAS-Proxy nutzen. Für neue proxy-fähige Apps ist ein Schalter proxyAktiv als Dropdown mit nein und ja empfehlenswert, damit Portalbetreiber zwischen Direktabruf und Proxy-Betrieb wählen können.

Proxy-Aufrufe verwenden POST. Als Query-Parameter path wird ausschließlich der URL-kodierte Pfad einschließlich Query der Zielressource übertragen, nicht die vollständige externe URL. Der Proxy-Endpunkt liegt am App-Basispfad und funktioniert deshalb auch bei Aufrufen über /app/index.html.

Lokale Live-Server-Tests prüfen dabei vor allem:

Echte Proxy-Antworten werden im ODAS-Live-System geprüft.

Tipps & Tricks

Prüfung und Auslieferung

Vor make zip sollte mindestens geprüft werden:

node --check app/app.js
node --check app/app-base.js
python3 -m json.tool app-package.json >/dev/null
python3 -m json.tool odas-config/config.json >/dev/null
python3 -m json.tool assets/schema.json >/dev/null

Zusätzlich werden Startseite, Hash-Routing, Logo-Link, Informationsseiten, Direktmodus und responsive Desktop-/Mobile-Ansicht im Browser geprüft.

Ondics-Standard

Für Ondics-Showcase-Apps gehen wir strenger vor:

Diese Punkte sind unser Qualitätsstandard. Für externe Entwickler sind sie eine hilfreiche Checkliste, aber nicht in jedem Punkt harte ODAS-Pflicht.

zurück zum Index