TE
TechEcho
Home24h TopNewestBestAskShowJobs
GitHubTwitter
Home

TechEcho

A tech news platform built with Next.js, providing global tech news and discussions.

GitHubTwitter

Home

HomeNewestBestAskShowJobs

Resources

HackerNews APIOriginal HackerNewsNext.js

© 2025 TechEcho. All rights reserved.

Ask HN: How do you write documentation for your public APIs?

4 pointsby nahcubalmost 12 years ago
Do you know of any good programs? Do you simply use a Markdown or RST document? Or do you know of something even better?<p>Thanks!

3 comments

bosky101almost 12 years ago
Wordnik's swagger comes to mind<p><a href="https://developers.helloreverb.com/swagger/" rel="nofollow">https://developers.helloreverb.com/swagger/</a><p>We just launched our own api ( handwritten with bootstrap,css )<p>check it out at <a href="http://appetite.io/docs" rel="nofollow">http://appetite.io/docs</a><p>~B
评论 #5853072 未加载
trevoroalmost 12 years ago
I really like using Restdown <a href="https://github.com/trentm/restdown" rel="nofollow">https://github.com/trentm/restdown</a><p>It's markdown with a few more conventions. Really handy.
swahalmost 12 years ago
Python has Sphinx, used by almost every big package.