Web API-dokumentation bliver nu interaktivt med Mashery I/O Docs

API-testværktøjet Mashery I/O Docs lægges nu ud som open source, hvilket gør det lettere at teste API-kald og dokumentere kaldet.

Mashery har annonceret, at virksomheden vil gøre deres Mashery I/O Docs open source. Maskery I/O Docs er et system til at generere interaktiv information om, hvordan web Applications Programmings Interfacen, API'en, virker. Det skriver H-online.

I/O Docs er inspireret af ’byPosterous API reference’ og af ’Wordnik documentation’. Så snart dokumentationen er genereret og loaded ind i en webbrowser, bliver de forskellige API-kald listet op på en side i 'hurtig reference form'. Hvis man klikker på en hvilken som helst af disse referencer, udvider man dem til at vise de parametre, som API-kaldet vil bruge.

I stedet for at være en passiv visning, har parametrene værdi-felter, der gør, at man kan selektere resultater i XML eller JSON format, og en ’prøv det’-knap, der vil udforme API-requesten med de angivne parameter-værdier. Herefter vil den vise det komplette kald, der foretages.

Dette format tillader derfor udviklere at eksperimentere med API’en, for at de på den made kan få en bedre forståelse for, hvordan API’en virker. Open source-systemet er skrevet som en Node.js-applikation og er tilgængeligt på Github under en MIT-licens.

Læs mere om værktøjet og dets funktionalitet her.

Tips og korrekturforslag til denne historie sendes til tip@version2.dk
Kommentarer (1)
sortSortér kommentarer
  • Ældste først
  • Nyeste først
  • Bedste først
Log ind eller Opret konto for at kommentere