Hacker Newsnew | past | comments | ask | show | jobs | submitlogin

You can try using API Blueprint (https://apiblueprint.org) which is based on Markdown can host your API docs at http://apiary.io

Disclaimer: I work at Apiary



For our corporate API, we the Apiary markdown with aglio to convert into nice documentation. I've tried RAML (I didn't like the giant YAML file) and apidoc (I didn't like to put 100 lines of user documentation next to 20 lines of implementation). I use protagonist to convert the md file to JSON which my Python code can load and compare with the decorated API endpoints -- I can then verify they and all their parameters are properly documented. I don't use the fancy Apiary features yet.




Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: