{"id":286,"date":"2013-04-10T10:56:03","date_gmt":"2013-04-10T08:56:03","guid":{"rendered":"http:\/\/blog.zeit.de\/dev\/?p=286"},"modified":"2015-09-17T11:24:00","modified_gmt":"2015-09-17T09:24:00","slug":"zon-api-ist-quelloffen","status":"publish","type":"post","link":"https:\/\/blog.zeit.de\/dev\/zon-api-ist-quelloffen\/","title":{"rendered":"ZON-API ist quelloffen"},"content":{"rendered":"

Seit dem Launch der Beta-Phase hat unsere API<\/a> nun mehrere Millionen Requests beantwortet. Wir haben spannende Projekte gesehen und viel konstruktives Feedback erhalten. Ein \u00f6ffentliches Bugtracking und der neue Twitterchannel @zeitonline_dev<\/a> waren die ersten Schritte, dieses Potenzial zu nutzen. Nun m\u00f6chten wir interessierten Entwicklern einen Einblick in unsere Schnittstelle geben. Alle Sourcen der API<\/a> sind ab sofort auf Github verf\u00fcgbar. Die Architektur erl\u00e4utern wir hier kurz.<\/p>\n

<\/p>\n

Vom CMS zur API zur App<\/strong><\/h3>\n

Der Publikationsprozess unseres Content Management Systems st\u00f6\u00dft eine Reihe von Aktionen an, die den Artikel auf unterschiedlichen Kan\u00e4len verf\u00fcgbar machen. F\u00fcr die API werden die Rohdaten des Artikels mit XSL transformiert und via HTTP an den API-Suchserver gesendet. Dies realisieren wir mit Solr<\/a>, einem Projekt der Apache Foundation. Solr basiert zum gr\u00f6\u00dften Teil auf Lucene Bibliotheken und bietet m\u00e4chtige Features zur Volltextsuche \u00fcber gro\u00dfe Datenmengen. Auch in anderen Bereichen von ZEIT ONLINE wird mit Solr-Technologie gearbeitet, so dass die Wahl f\u00fcr das API-Projekt nahe lag. Die API benutzt f\u00fcr Suchanfragen den ExtendedDisMax Query Parser<\/a> von Solr. Dieser ist bez\u00fcglich der Syntax sehr fehlertolerant und gut geeignet, Benutzereingaben direkt zu verarbeiten. Er unterst\u00fctzt die volle Suchsyntax und kann spezifische Queries mit boolschen Verkn\u00fcpfungen, Feldselektoren oder Zeitspannen verarbeiten.<\/p>\n

Die sogenannte Facettierung ist ein weiteres Feature von Solr, das f\u00fcr Gruppierung und Quantifizierung von Inhalten n\u00fctzlich ist. Eine Facette eines Feldes zeigt an, welcher Wertebereich innerhalb der Suchanfrage vorkommt und wie oft ein Wert vertreten ist. Eine Facette ist also eine Untermenge der eigentlichen Query.<\/p>\n

Solr bildet keine Relationen zwischen Elementen ab. Deshalb haben wir uns f\u00fcr eine Hybrid-L\u00f6sung entschieden: Der Suchserver indexiert Artikeltexte und konstante IDs der zugeh\u00f6rigen Metadaten-Objekte. Die Metadaten-Objekte selbst werden in einer relationalen Datenbank unter der entsprechenden ID als Schl\u00fcssel gespeichert. Dies ist zum Beispiel die Kategorie und lexikalische Schreibweise eines Schlagworts. Durch diese Trennung k\u00f6nnen globale \u00c4nderungen an Metadaten durchgef\u00fchrt werden, ohne dass alle betroffenen Artikel neu indexiert werden m\u00fcssen.<\/p>\n

Ein HTTP-Request an die API wird von einer Middleware auf Basis des Web Frameworks Flask<\/a> beantwortet. Die Parameter und deren Werte werden auf G\u00fcltigkeit \u00fcberpr\u00fcft und der angegebene API-Key verifiziert. War die Anfrage valide, muss sie zun\u00e4chst f\u00fcr den Solr \u00fcbersetzt werden, da dessen REST<\/a>-Interface leicht von dem unserer API abweicht.<\/p>\n

Die Maskierung und Reduktion der umfangreichen M\u00f6glichkeiten von Solr soll die Bedienung der API vereinfachen und ist dem Datenschema angepasst. Als Ausgabeformat setzen wir auf JSON. Es ist schemafrei, wird von den meisten Sprachen und Plattformen unterst\u00fctzt und ist auch in Rohform noch gut lesbar.<\/p>\n

Happy Developing<\/strong><\/h3>\n

Wir freuen uns \u00fcber jeden Fork,\u00a0 jeden Pull-Request und auf einen regen Austausch. Unser Code unterliegt der BSD-Lizenz<\/a>, da diese Entwicklern alle Freiheiten gibt, Code zu ver\u00e4ndern und zu redistribuieren. \u00dcber einen kurzen Hinweis, wo und wie unser API-Code zum Einsatz kommt, w\u00fcrden wir uns freuen.<\/p>\n

Wir werden unsere API selbstverst\u00e4ndlich weiter verbessern. Auch Bugreports und Featurerequests sind weiterhin willkommen.<\/p>\n

Links zum Thema<\/strong><\/p>\n