Wie man bessere APIs entwickelt Teil 3

11. Gib die bei POST erstellte Ressource zurück Es ist eine gute Idee, die erstellte Ressource zurückzugeben, nachdem sie mit einer POST-Anfrage erstellt wurde. Das ist vor allem deshalb wichtig, weil die zurückgegebene, erstellte Ressource den aktuellen Zustand der zugrundeliegenden Datenquelle widerspiegelt und vielleicht aktuellere Informationen enthält (z. B. eine generierte ID). // Request: POST /users{    „email“: „jdoe@averagecompany.com“,    „name“: „John Doe“}// Response{    „id“: „T9hoBuuTL4“,    „email“: „jdoe@averagecompany.com“,    „name“: „John Doe“} 12. […]

Wie man bessere APIs entwickelt Teil 2

6. Akzeptiere API-Schlüssel-Authentifizierung Wenn eine API von einer dritten Partei aufgerufen werden muss, ist es sinnvoll, die Authentifizierung über API-Schlüssel zuzulassen. API-Schlüssel sollten mit einem benutzerdefinierten HTTP-Header (z. B. Api-Key) übergeben werden. Sie sollten ein Ablaufdatum haben, und es muss möglich sein, aktive Schlüssel zu widerrufen, damit sie ungültig gemacht werden können, falls sie kompromittiert werden. Vermeide das Einchecken von API-Schlüsseln in die Versionskontrolle (verwende stattdessen Umgebungsvariablen). 7. Verwende sinnvolle HTTP-Statuscodes Verwende konventionelle HTTP-Statuscodes, um […]

Wie man bessere APIs entwickelt Teil 1

Wenn man eine API von Grund auf neu erstellt, muss man viele Details beachten. Von grundlegenden Sicherheitsüberlegungen bis hin zur Verwendung der richtigen HTTP-Methoden, der Implementierung von Authentifizierung, der Entscheidung, welche Anfragen und Antworten man akzeptiert und zurückgeben sollte, … die Liste ist endlos. In diesem Beitrag wird versucht, die Punkte zu betrachten, die nützlich sein können, um eine gute API zu entwicklen. Eine API, die gerne benutzt wird. Alle Tipps sind sprachunabhängig und gelten […]

Confluence-Seiten mit der REST-API verwalten

Falls zum Informationsaustausch und zur Kommunikation im Unternehmen Confluence von Atlassian eingesetzt wird, dann kann es manchmal sinnvoll sein, Seiten automatisch erstellen zu lassen, um z.B. mit einer Auslieferung zeitgleich Release Notes zu veröffentlichen.Mit dem folgenden Skript confluence_util.py lassen sich per HTTP-Aufruf Seiten erstellen, ändern oder löschen (sofern der Benutzer die benötigten Rechte besitzt). In dieser Version wird für die Authentifizierung eine auth-Datei verwendet. Diese Datei lässt sich mit dem Skript create_authorization.py erzeugen. Weitere Informationen […]