1. 程式人生 > >告別手寫 API文件生成工具推薦

告別手寫 API文件生成工具推薦

轉自:原文連結

隨著API的發展以及需求的日益增加,對API文字文件的需求與隨之而來。相信許多開發人員都遇到過編寫API文件方面的問題及煩惱。

你是否還通過手寫的方式來生成和編寫這些文件呢?那麼你就OUT啦!話說工欲善其事必先利其器,本文分享8款非常好的API文件生成工具給大家。


Web API文件工具列表

Swagger ——Swagger框架可以通過程式碼生成漂亮的線上API,甚至可以提供執行示例。支援Scala、Java、Javascript、Ruby、PHP甚至 Actionscript 3。線上 Demo 

I/O Docs ——I/O Docs是一個用於RESTful Web APIs的互動式文件系統。使用 JSON 模型根據資源、方法和引數定義 APIs。I/O Docs 將生成 JavaScript 客戶端介面,可通過這些介面來呼叫系統。伺服器端基於 

Node.js 開發。線上Demo

apiary.io ——能夠快速啟動和執行文件,包括GitHub整合和I/O驗證——更多建議可以前往Reddit檢視上關於 Siyfion討論。

Docco ——Docco是一個快速而隨意、hundred-line-long、迭代程式風格的文件生成器。它會以HTML的方式顯示評論和程式碼。

Dexy ——非常靈活的一款文件工具,支援任何語言編寫的API。

Doxygen ——Doxgen可以從一套歸檔原始檔開始,生成HTML格式的線上類瀏覽器,或離線的LATEX、RTF參考手冊。對於未歸檔的原始檔,也可以通過配置Doxygen來提取程式碼結構。 更多建議可以前往Reddi上檢視 

gkumar007相關討論。

——是一款付費的文件API工具。裡面包含了智慧WIKI編輯器、基於標準的Markdown、文件分支、還可以與Git、SVN、Mercurial同步、整潔的主題、友好的介面。

以上僅是作者在實踐中發現的一些很好的工具,如果你有更好的建議或工具推薦,歡迎與我們分享。

相關推薦

告別 API生成工具推薦

轉自:原文連結 隨著API的發展以及需求的日益增加,對API文字文件的需求與隨之而來。相信許多開發人員都遇到過編寫API文件方面的問題及煩惱。 你是否還通過手寫的方式來生成和編寫這些文件呢?那麼你就OUT啦!話說工欲善其事必先利其器,本文分享8款非常好的API文件生成

API生成工具推薦

隨著API的發展以及需求的日益增加,對API文字文件的需求與隨之而來。相信許多開發人員都遇到過編寫API文件方面的問題及煩惱。 你是否還通過手寫的方式來生成和編寫這些文件呢?那麼你就OUT啦!話說工欲善其事必先利其器,本文分享8款非常好的API文件生成工具給大家。 W

Swagger-告別介面

隨著網際網路技術的發展,現在的網站架構基本都由原來的後端渲染,變成了:前端渲染、前後端分離的形態,而且前端技術和後端技術在各自的道路上越走越遠。 前端和後端的唯一聯絡,變成了API介面;API文件變成了前後端開發人員聯絡的紐帶,變得越來越重要,swagger就是一款讓你更好的書寫A

使用API生成工具-sphinx

Python第三方庫sphinx可以自動化為restful API生成文件,使用步驟如下所示:1. 安裝pip install sphinx2. 建立文件目錄mkdir document3. 配置配置方

Python的支持工具[1] -> 可執行生成工具 -> cx_freeze

pack orm excludes ase rom ble font mes package cx_freeze cx_Freeze 是一個第三方庫,可以用於將 Python 的代碼打包成可執行文件,下面介紹如何利用一個腳本文件將 Python 代碼變為 e

最簡單的Markdown生成工具 book-cli

目前的文件編寫工具,我想大概推薦: gitbook vuepress ydoc 其他的我都不太清楚了,還有一些國內文件編寫的網站,各種選擇。 是的,造輪子的人又來了。 當下的問題: gitbook 我就不說了,程式碼老舊,控制元件庫質量層次不齊,我改了一天,勉強能看,再弄弄,居然

Swagger-API生成框架的基本使用

  使用工具、框架的目的就是為了開發過程簡潔方便或者是達到更強大的功能效果。在目前網際網路開發發展的趨勢下,由於技術更加深度化、細化,前後端分離開發成為必不可少的一個環節,而後端和前端開發人員之間唯一的橋樑便是API文件,也就是介面文件。   平時開

nodejs restful 的api生成

1、apidoc的官網 http://apidocjs.com   2、安裝nodejs環境,安裝apidoc  npm install apidoc -g   3、在專案根目錄建立:apidoc.json;如: {   "name": "

資料庫生成工具

NPoi public void CreateToWord(List<string> list,string conStr,string db) { XWPFDocument doc = new XWPFDocument(); //建

.NET平臺開源專案速覽(4).NET生成工具ADB及使用

    很久以前就使用ADB這個工具來生成專案的幫助文件。功能強大,在學習一些開源專案的過程中,官方沒有提供CHM幫助文件,所以為了快速的瞭解專案結構和註釋。就生成文件來自己看,非常好用。這也是一個學習方法吧。例如本文在:   上述2篇文章中最後的資源中就手動製作了CHM幫助文件。有時候我們還可

DBImport v3.5 中文版釋出:資料庫定時同步及生成工具(IT人員必備)

前言: 趁著最近的休息時間,只能多勤快些:多寫程式碼,多更新文章。 因為一旦投入新的工作,估計部落格又會恢復到一年才產幾篇的狀態。 對於DBImport,因為使用者的意見,增加了一個亮點功能,讓軟體B格升為資料庫時時同步工具,所以值的介紹一下。 相比上一版本的主要功能

Doxygen—程式生成工具

         Doxygen是一種開源跨平臺的,以類似JavaDoc風格描述的文件系統,完全支援C、C++、Java、Objective-C和IDL語言,部分支援PHP、C#。註釋的語法與Qt-Doc、KDoc和JavaDoc相容。Doxgen可以從一套歸檔原始檔開始

python pydoc-生成工具(彙總tcy)

pydoc-文件生成工具   2018/9/8 ------------------------------------------------------------------------------ 1.1.用途: 是python自帶的一個文件生成工具,使用p

AspnetCore 2.0 自動API生成元件,支援protobuffer

關於API文件自動生成,用於對APP端的開發幫助文件生成,預設ProtoBuffer傳輸格式。本

生成工具之NodeJS+doxmate

Nodejs D:\Program Files\nodejs 安裝doxmate 在windows下面使用doxmate 配置環境變數C:\Users\cs\AppData\Roaming\npm無效! 加上C:\Users\cs\AppData\Roa

docker部署頂尖 API 管理工具Yapi

前言介紹 Yapi 由 YMFE 開源,旨在為開發、產品、測試人員提供更優雅的介面管理服務,可以幫助開發者輕鬆建立、釋出、維護 API。 專案地址:https://github.com/YMFE/yapi docker pull silsuer/

API管理工具折射出的技術視野

所謂技術視野,就是看問題時所能切換的不同角(維)度。 下面就以API管理工具(以下簡稱“管理工具”)為例,來探討背後隱藏的技術視野。 API管理工具 零視角 曾經在一個小型創業公司用到過最簡單的管理工具,就是一個開源的文件管理工具,介面功能類似wiki(維基百科)。 這樣的工具確實能滿足核心需求——API線

api自動生成工具

安裝教程 spring-boot整合: 1. 新增依賴 - 新增依賴包 <dependency> <groupId>com.gitee.sergius</groupId>

使用Easy CHM工具對檔案生成API

本案例是在eclipse中執行的(API文件的生成一般配合註解使用) 專案準備:下載工具Easy CHM   官方網站下載:http://www.etextwizard.com/cn/easychm.html(注:官方的需要購買,但可以免費試用) 這裡免費已下載好

使用javadoc工具生成API

由於文件註釋適用於生成API文件的,而API文件主要用於說明類、方法、成員變數的功能。因此javadoc工具只處理文件原始檔在類、介面、方法、成員變數、構造器和內部類之前的註釋,忽略其他部分的註釋。而且javadoc工具預設只處理以public或protected修飾的類、