Zum Hauptinhalt springen

Swagger UI

Die Swagger UI ist kein Bestandteil von mapedit-core, jedoch wird es genutzt, um die Funktionen von mapedit-core zu nutzen ohne dieses in ein Programm einzubinden.

Die Funktionen des Backends sind hierbei in verschiedene Services unterteilt, wobei jeder Service für ein Aufgabengebiet zuständig ist.

Beachten Sie, dass beinahe alle Funktionen eine Authentikation erfordern. Lediglich Funktionen wie die Anmeldung selbst können ohne Anmeldung ausgeführt werden.

Hinweis

Bitte beachten Sie stets, dass Sie mit Swagger auf alle Funktionen des Backends zugreifen können. Überprüfen Sie bitte stets Ihre Angaben, bevor Sie diese absenden um Fehler in Ihrer Datenstruktur zu verhindern.

ApplicationService

Dieser Service wird innerhalb von Anwendungen, wie MapEdit Mobile, genutzt, um Projekte abzuholen, Formulare zu öffnen oder eine Netzverfolgung zu starten.

AuthenticationService

Der AuthenticationService wird zur Anmeldung und Abmeldung genutzt. Mehr hierzu unter Nutzung.

ConfigurationService

Kann dazu genutzt werden Konfigurationsdateien im Rohformat abgerufen werden. Dies wird jedoch nur zu internen Zwecken benötigt.

CoreService

Ein interner Service zum Ausführen von Testfunktionen

DataService

Der DataService wird dazu genutzt Datensätze vom Server abzuholen, diese zu Editieren oder zu löschen. Auch SQL-Queries können hierüber abgeschickt werden.

Achtung

Kontrollieren Sie stets Ihren Query, bevor Sie diesen absenden. Fehlerhafte Queries bzw. Queries, die einen semantischen Fehler enthalten, können Schäden in Ihren Daten bewirken, da Datensätze editiert oder gelöscht werden könnten.

DocumentsService

Mit Hilfe des DocumentsService können Dokumente auf den Server geladen werden bzw. von diesem abgeholt werden.

JobsService

Hier können aktuell im Backend ausgeführte Jobs abgefragt werden. Dies ist nur in speziellen Fällen, z.B. zur Fehlersuche notwendig.

LunrService

Der LunrService ist die Grundlage für die Volltextsuche. Hier können Testsuchen ausgeführt werden oder Suchen neu indiziert werden.

MapService

Der MapService wird als Hilfsservice für die Mapbox-Karte genutzt. Hierüber können beispielsweise Sprites (also die Symbole, welche in der Karte genutzt werden) abgerufen werden.

RepositoryService

Der RepositoryService ermöglicht die Verwaltung des MapEdit Repositories. Hier können Konfigurationen abgerufen werden oder mapedit-core mit dem AppBuilder synchronisiert werden.

TilesService

Hier werden die VectorTiles verwaltet, so zum Beispiel neue Tabellen registriert oder einzelne VectorTiles abgerufen.