Wissensdatenbank
Neue Website zur API-/Entwicklerdokumentation
Warum eine neue Seite über IDEA API erstellen? Als Reaktion auf die Nachfrage nach mehr Informationen über Aufbau und Individualisierung von Datenverbindungen. BIM-Link-Ersteller, Entwickler von Design-Automatisierungs-Tools und Experten für visuelle Programmierung können nun alles einfacher finden.
Wo kann man sie dann finden?
developer.ideastatica.com ist die richtige Anlaufstelle.
Diese neue Dokumentations-Website bietet Entwicklern von Drittanbietern und API-Skriptern einen zentralen Zugang zu Informationen über die öffentlichen Dienste und den Code von IDEA StatiCa.
Die Seite verbindet Statikdokumentation, Codedokumentation und spezifische Beispiele für alle im ersten Absatz erwähnten Personas.
Verbesserungen gegenüber dem vorherigen Stand
- Die öffentliche GitHub-Webseite bietet eine Menge nützlicher Informationen, ist aber nicht immer leicht zu navigieren. Daher werden wir Entwicklern einen einzigen Zugangspunkt zur Verfügung stellen.
- Versionshinweise für wichtige Änderungen werden den Entwicklern helfen, zu benachrichtigen, wann und wie sie ihre Drittanbieteranwendungen aktualisieren müssen.
- Eine Unterscheidung zwischen öffentlichen WIP-Entwicklungen (die nicht als Produkte verwendet werden sollten) und funktionierenden Produkten mit Dokumentation.
- Wiki bietet die Möglichkeit, Code-Dokumentation zu erstellen und diese mit Kategorien und Konzepten zu verknüpfen.
- Das Wiki wird automatisch aktualisiert und gewartet.
- Beispiele sind von der Dokumentation aus leicht zugänglich.
Die Seite ist in 4 verschiedene Bereiche unterteilt:
- IDEA Open Model (IOM) - Abschnitt über die Erstellung und Spezifikation des IOM-Datenmodells.
- BIM Links (BIM API) - Abschnitt über die Erstellung von Checkbot BIM Links unter Verwendung des BIM API Frameworks.
- Design API (API) - Abschnitt über Design App API's.
- Extensions - Abschnitt über Erweiterungen, die auf der Grundlage der Design-App-APIs erstellt werden.