TE
科技回声
首页24小时热榜最新最佳问答展示工作
GitHubTwitter
首页

科技回声

基于 Next.js 构建的科技新闻平台,提供全球科技新闻和讨论内容。

GitHubTwitter

首页

首页最新最佳问答展示工作

资源链接

HackerNews API原版 HackerNewsNext.js

© 2025 科技回声. 版权所有。

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

4 点作者 nahcub将近 12 年前
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 条评论

bosky101将近 12 年前
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 未加载
trevoro将近 12 年前
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.
swah将近 12 年前
Python has Sphinx, used by almost every big package.