Im Forschungsprojekt ZuSiNa wurde eine Schnittstelle entwickelt, die zu Textilprodukten entsprechende Nachhaltigkeitssiegel ausgeben soll. Die Datenschnittstelle ist eine Rest API, die mit Django entwickelt wurde.
Die hier gezeigt Implementierung enthält keine Lastverteilung. Bei einer produktiven Verwendung kann eine solche Lastverteilung jedoch Sinn ergeben.
Um die Schnittstelle zu implementieren muss das Django Framework installiert werden. Auf der Seite https://docs.djangoproject.com/en/4.2/intro/install/ wird beschrieben wie dies geht.
Mit Django kann dann eine REST API erstellt werden, dafür muss ein Django Projekt erstellt werden
django-admin startproject zusina_api
und es müssen einige Programme installiert werden, die in der requirements.txt zu finden sind.
In dem Projektordner zusina_api müsste eine Datei namens manage.py und ein Ordner zusina_api sein. In dem Ordner zusina_api befindet sich die Datei settings.py in die wir nun folgendes einfügen:
INSTALLED_APPS = [
...
'rest_framework',
'django_filters',
'zusina_api',
'rest_framework.authtoken',
]
Um später Authentifizierung zu ermöglichen fügen wir folgendes ebenfalls der settings.py hinzu:
REST_FRAMEWORK = {
'DEFAULT_AUTHENTICATION_CLASSES': [
'rest_framework.authentication.BasicAuthentication',
'rest_framework.authentication.SessionAuthentication',
'rest_framework.authentication.TokenAuthentication',
],
'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination',
'PAGE_SIZE': 10
}
Dem Projekt werden dann die Dateien aus diesem Repo hinzugefügt. Diese kommen in den selben Ordner wie settings.py.
models.py
serializer.py
views.py
admin.py
Damit eine passende Datenbank hinzugefügt wird müssen folgende Kommandos verwendet werden:
python manage.py makemigrations <projektname>
python manage.py migrate
Es sollte noch ein superuser hinzugefügt werden, um auf die Datenbanken über /admin zuzugreifen.
python manage.py createsuperuser --username <superusername>
Bevor die Schnittstelle aufgerufen werden kann müssen noch die Adressen registriert werden. Dies geschieht durch hinzufügen der folgenden Zeilen zu der Datei urls.py.
...
from zusina_api.views import ProductAPIView, ProductDetailAPIView
urlpatterns = [
...
path('api/', ProductAPIView.as_view()),
path('api/alldata', ProductDetailAPIView.as_view()),
]
Danach kann der Server gestartet werden.
python manage.py runserver
In dieser Dokumentation verwenden wir als Adresse die Beispieladresse zusina.ni.dfki.de. Wird der Server gestartet, läuft dieser auf dem Port 8000 im Pfad /api (zusina.ni.dfki.de:8000/api). Dort ist eine grafische Oberfläche zu finden, um die Funktionen der Schnittstelle zu testen. Einloggen kann sich der Nutzer mit dem zuvor erstellten Superuser. Über den Button Options oben rechts können verschiedene Filter gesetzt werden.
Zur Verwendung ohne grafische Oberfläche kann z.B. das Kommandozeilenprogramm cURL verwendet werden. Ein GET-Request ohne Parameter liefert die Einträge aus der Datenbank zurück. Dabei muss Nutzer sich mit Nutzername, Passwort oder ein Token authentifizieren. Token können unter /admin erstellt werden.
curl http://zusina.ni.dfki.de:8000/api/ -H "Authorization Token <key>"
Sollen die Ergebnisse gefilter werden können die vorhandenen Parameter verwendet werden, diese sind:
- is_manufacturer - ist die Marke auch der Hersteller?
- brand - die Marke des Produkts
- product_description - Name und Beschreibung des Produkts
- productid - eindeutige Identifizierungsmöglichkeit des Produkts
- brandid - eindeutige Identifizierungsmöglichkeit des Herstellers
- ecolabel - Das Umweltsiegel
- ecolabel_informations - Informationen zu dem Umweltsiegel
- startdate - wann das Produkt zertifiziert wurde
- enddate - wann das Siegel abläuft
Um beispielsweise nach einem Hersteller zu filtern kann folgendes Kommando verwendet werden:
curl http://zusina.ni.dfki.de:8000/api/?brand=Tesbrand -H "Authorization Token <key>"
Auch mehrere Filtern können gesetzt werden:
curl http://zusina.ni.dfki.de:8000/api/?brand=Tesbrand&ecolabel=Testlabel -H "Authorization Token <key>"
Eine Suche über alle Felder ist ebenfalls möglich mit:
curl http://zusina.ni.dfki.de:8000/api/?search=Testsuche -H "Authorization Token <key>"
Die Datei Client.py enthält ein kleines Programm, das es Nutzern ermöglicht eine CSV-Datei an einen Server zu schicken und so Siegelinformationen hinzuzufügen.
Die Dateien in diesem Repository wurden im Rahmen des Forschungsprojekts ZuSiNa, das vom Bundesministerium für Umwelt, Naturschutz, nukleare Sicherheit und Verbraucherschutz (BMUV) gefördert wird (FKZ: 67KI21009A) vom DFKI entwickelt. An dem ersten Arbeitspaket, in dem diese Dateien entwickelt wurden, sind die Institute ConPolicy (Leitung von AP1), Fraunhofer CERRI und DFKI beteiligt. Weitere Informationen sind auf https://www.zusina-projekt.de/ zu finden.