1樓：何小宇
安利下我的解決方案，採用OAS3+ReDoc，已經發布為Spring Boot Starter，簡單易用並且漂亮~
使用說明：
何傻子：Spring MVC應用的最佳API文件解決方案：OAS3+ReDoc
2樓：霜刃
安利乙個文件工具
Share-API 更好用的 Swagger 文件檢視工具基於swagger.json 渲染成視覺化文件工具，支援私有，公有，以及密碼管理，ip白名單管理等
ShuangRen/share-api
3樓：
個人覺得Swagger, RAML都是不錯的選擇，特別是配套的editor和designer, 讓其api在完成之後不單能看還能測！
不過raml到1.0了，很多第三方庫仍舊停留在0.8. 而swagger則是到2.0遲遲不動．
另外，如果是新開發api, 又要寫文件，又要寫實現就比較煩人了．所以有一些框架會將swagger或raml整合，將api的實現整合在一起．這樣的有很多，這裡推薦乙個俺自己寫的框架，pingf/falsy，如果你用python開發的可以試試，還是相當清爽的～（當然其本身的文件暫時還不太全，不過demo資料夾下有很多現成可用的例子咯）
4樓：mlyhrb
API 重在設計上，如果有一套通用 API 設計語言，如 Swagger，API Blueprint, RAML。設計者、開發者、使用者之間通過這套語言來溝通，就無所謂文件好看了。推薦看這裡：
5樓：張磊
可以試試EasyAPI http://www.
easyapi.com
，希望國內開發者多多支援國內的產品。
應該算國內最早做API文件管理的產品。希望大家多多提些建議。
6樓：D瓜哥
AsciiDoctor，你知道擁有。我寫了個文件，我領導說我的排版水平和出書了，其實我只是用來簡單的 AsciiDoc 而已。呵呵
7樓：江巨集
LeanCloud 的文件專案是開源的：GitHub - leancloud/docs: LeanCloud Documentation
8樓：Dennis Yang
比較好用的是swagger-ui, 可以使用swagger editor來編寫。此外slate api編輯器也不錯。
slate demo(Paracel - API Reference)
以上是編輯器。你想在你的專案中自動生成，那麼得需要相關的外掛程式。我做rails開發的，使用swagger，那麼有swagger docs for rails外掛程式，其他語言的自行搜尋。
rails專案中apipie rails也不錯。
這裡的編輯器不支援md，自己格式化一下。
#### articles
1. [standard json api](Standard JSON API response format?)
2. [api doc tools](Tools to generate beautiful web API documentation)
#### 我們公司的json格式
```ruby,]
},links:
}```
#### 相關鏈結
9樓：陳振宇
原來API文件還可以這麼屌！Apiary還開源了APIBlueprint，可以用markdown寫文件，還可以通過中間工具發布到Github pages。
如何才能寫出讓人欲罷不能的爽文？
開穹 最爽的爽文在中國寫不得，一發表就違法。如何才能寫出？堅持馬列主義的基本路線，遵循科學發展觀與四個基本原則，深入走基層體會各個階級的生活方式以及喜怒哀樂，反映新時代的社會面貌與發展需求。 在哪裡 主角受到挫折後，實力突破，將仇人打的滿地找牙，仇人不甘示弱，不斷製造難題，要高潮迭起，不停製造懸念。...
如何才能寫出孤獨感？
盧哥 灶台裡的火飄飄忽忽，時明時暗。你單手扶膝坐在柴火旁，另乙隻手百無聊賴的拔弄著灶台裡的柴火，鍋裡的水咕嚕咕嚕冒著熱氣。說好的六點下班到家，你只想為她下一碗熱滕滕的麵條，可是到現在還沒回，又加班了吧 聞彬 身與心的孤獨，互相映照，才是真正的孤獨。人在世上，身單影只是孤獨。曲高和寡，是孤獨。能致而不...
如何才能寫出priest那樣的作品？
念奴嬌 我看過幾部她的作品。嗯，怎麼說呢，多讀書吧，引用古詩文什麼的可以提公升格調 不過我其實是來唱反調的，你不要模仿啊，形成自己的文風不好嗎？不要寫別人那樣的文章。要寫出自己的文章。 Solitude 這個問題底下戾氣好重 p大屬於熬出來的，天賦什麼的沒法說。成就在網文作者裡也是數一數二的 殘次品...