ublaboo/api-docu: Documentation generating for ApiRouter routes – awesome runtime documentation
- Pavel Janda
- Člen | 977
Doplněk pro dokumentaci rout vytvořených doplňkem
ublaboo/api-router (vlastní vlákno zde).
Anotací definuji podrobnější informace a z těch je generována dokumentace. Existují 2 druhy generování dokumentace:
1, Vlezu na některou api routu a do url parametru zadám
?__apiDocu. Potom se mi okamžitě zobrazí dokumentace routy, na
kterou jsem vlezl (Pro zobrazení api dokumentace POST/PUT/DELETE rout mohu
forcenout http metodu parametrem ?__apiRouteMethod).
2, Vlezu na některou api routu a do url parametru zadám
?__apiDocuGenerate. Potom se mi okamžitě vygeneruje api
dokumentace restových rout do předem určeného adresáře (výchozí
wwwDir/api).
Componette: https://componette.org/…oo/api-docu/.
Stránky projektu/dokumentace s ukázkami: http://ublaboo.paveljanda.com/api-docu/.
Editoval Pavel Janda (18. 2. 2016 12:33)
- Pavel Janda
- Člen | 977
- martin.knor
- Člen | 17
Usetrim nekomu spoustu casu – v dokumentaci zde http://ublaboo.org/…ocumentation je ?__apiDocGenerate, kde chybi u mezi Doc a Generate, chvili mi trvalo nez jsem na to prisel :)
Editoval martin.knor (7. 9. 2016 8:55)