1) Pomoci MarkDownu popisete dokumentaci k HTTP API - napriklad ze na HTTP GET ma prijit response 200 OK a nejaka data (napriklad nejaky JSON).
Vtip je v tom, ze nektere znacky MarkDownu (napriklad pro nadpis, podnadpis) maji specialni vyznam - zacatek Response apod. API vlastne popisete markdownem pomoci prikladu.
2) Vygeneruje vam to 1. krasnou dokumentaci, za 2. vam to kontroluje, jestli server opravdu odpovida tak, jak jste nadefinovali a za 3. muzete rozbehnout mock server.
=> Timpadem dokumentace nezastarava, nemusite psat nekolik dokumentu - dokumentaci a technicky popis API - vse je v jednom.
Na toto vsechno jiz nastroje existuji, Apiary pouzivat nemusite a dopracujete se ke stejnemu vysledku. Apiary je ale sloucilo do jedne online sluzby, kde si s tim nemusite hrat a mate to na jedno kliknuti.
Navic (a to je IMHO nejdulezitejsi z hlediska jejich businesu) vase API muze byt verejne a toho vyuzivaji zname sluzby - pres Apiary vystavi rozhrani k jejich sluzbam.
dekuji,
Taky mi dochazi, proc to treba Oracle koupi, jestli maji stovky ruznych produktu, ke kterym by museli zvlast delat ty dokumentace, Pak je urcite vyhoda, mit na to jen jeden nastroj.
Upozorníme vás na články, které by vám neměly uniknout (maximálně 2x týdně).
