APIs dokumentieren und testen mit apiary.io

Mit dem Start von Getnudged startete ich nicht nur die erste Firma mit Julian Lang, nein… ich entwickle gerade auch meine erste API basierend auf meinem Open Source PHP Framework. Damit das auch richtig professionell wird und ist, dokumentiere ich die API natürlich auch. Aber auch das mache ich zum ersten Mal und suchte daher nach einer Hilfe, oder am besten auch direkt nach einem Tool das mir dabei hilft. Ich bin fündig geworden.

Apiary heißt das Zauberwort…

… oder auch das umfangreiche Tool, dass ich dir hiermit empfehlen möchte.

Mit Apiary lassen sich Dokumenationen von deinem Code erstellen. Wenn du alles richtig angehst, kannst du sogar deine API testen, Parameter und Attribute vorgeben und und und.

Bei der Erstellung deiner Dokumentation hilft dir die API Blueprint – die “API description language”! Ein Request mit Response könnte dann so aussehen:

# Group Roles

## View Roles [/get/roles]

### List All Roles [GET]

Retrieve all existing roles, with their ids.

+ Response 200 (text/html)

        [
            {
                "role_id":"",
                "role_name":""
            }
        ]

Jo, ich weiß. Response 200 text/html und die Ausgabe ist JSON? Da muss ich noch ein wenig dran arbeiten – den richtigen Header setzen. ABER darum geht es ja gar nicht.

Wenn du dir das Ganze einmal live ansehen möchtest, kannst du dir gerne die Getnudged API Dokumentation anschauen. Mein Englisch ist die Hölle, ich weiß. Aber sie ist ja auch nur für mich – eigentlich.

Hat dir der Beitrag gefallen?
Ja
Nein

Posted by Kevin Pliester

Kevin ist PHP- und WordPress-Entwickler. Gelegentlich teilt er auch Tipps zum Thema Selbstständigkeit. Er ist seit 2015 glücklich verheiratet, lebt in Dormagen und arbeitet immer von Zuhause aus. Kevin telefoniert nicht gerne und bevorzugt die Kommunikation via E-Mail oder Chat.

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.