❶ 如何快速編寫api文檔
剛開始寫介面文檔的服務端同學，很容易按著代碼的思路去編寫介面文檔，這讓客戶端同學或者是服務對接方技術人員經常吐槽，看不懂介面文檔。這篇文章提供一個常規介面文檔的編寫方法，給大家參考。
推薦使用的是docway寫介面文檔，方便保存和共享，支持導出PDF MARKDOWN，支持團隊項目管理。
一、請求參數
1. 請求方法
GET
POST
PUT
DELETE
其他
application/x-www-form-urlencoded
application/json
application/xml
multipart/form-data
用於獲取數據
用於更新數據，可與PUT互換，語義上PUT支持冪等
用於新增數據，可與POST互換，語義上PUT支持冪等
用於刪除數據
其他的請求方法在一般的介面中很少使用。如：PATCH HEAD OPTIONS
2. URL
url表示了介面的請求路徑。路徑中可以包含參數，稱為地址參數，如**/user/{id}**，其中id作為一個參數。
3. HTTP Header
HTTP Header用於此次請求的基礎信息，在介面文檔中以K-V方式展示，其中Content-Type則是一個非常必要的header，它描述的請求體的數據類型。
常用的content-type：
請求參數使用「&」符號連接。
內容為json格式
內容為xml格式
內容為多個數據組成，有分隔符隔開
4. HTTP Body
描述http body，依賴於body中具體的數據類型。如果body中的數據是對象類型。則需要描述對象中欄位的名稱、類型、長度、不能為空、默認值、說明。以表格的方式來表達最好。
示例：
五、介面工具
推薦使用的是http://docway.net（以前叫小幺雞） 寫介面文檔，方便保存和共享，支持導出PDF MARKDOWN，支持團隊項目管理。
❷ api文檔如何使用
你下的裡面應該都是些聲明吧，就在編程時先打那段聲明然後在下面引用。
❸ 如何使用百度雲API介面
http://developer..com/wiki/index.php?title=%E5%B8%AE%E5%8A%A9%E6%96%87%E6%A1%A3%E9%A6%96%E9%A1%B5/%E8%B5%84%E6%BA%90%E4%B8%8B%E8%BD%BD
學習了網路雲盤文件API介面的使用；初步是想做一個在線android應用，應用中的文檔是存放在網路雲盤的。
主要是分一下幾個步驟：
1.注冊網路賬號
2.登錄網路開發者中心
3.創建移動應用，獲取對應的（API Key Secret Key）
4.開通pcs API許可權
5.獲取ACCESS_token（認證編碼）
6.開發應用
注意：
開通移動應用，獲取key
獲取token的時候我使用的安卓獲取的方式
通過我寫對應api的例子我發現，其實就兩種情況：一種是get方式提交數據，另外一種是post方式提交數據
1.get方式提交數據，我們用獲取雲盤的信息為例：
獲取雲盤信息前我們要知道，我們要准備好什麼數據：
請求參數：
url: 標明我們要訪問的網址路徑 值固定問""
method:標明我們是請求雲盤信息 值固定為"info"
acceess_token:准入標識 值是我們自己申請的
接收返回參數：
quota:雲盤總容量
used:雲盤使用容量
request_id:該請求的表示，沒啥用
返回的一個json串如下格式：{"quota":123794882560, "used":83573494688,"request_id":2853739529}
我在做的時候你使用Gson工具將json串轉換到對應的entity類中了 代碼如下：
[html] /**
* @param URLConnection conn通過get方式獲取StringBuffer
* @return
*/
private StringBuffer getJsonString（URLConnection conn） {
InputStreamReader isr = null;
BufferedReader br = null;
StringBuffer sb = null;
try {
isr = new InputStreamReader（conn.getInputStream（），"gb2312"）；
br = new BufferedReader（isr）；
String line = null;
sb = new StringBuffer（）；
while （（line = br.readLine（）） != null） {
sb.append（line）；
sb.append（"\r\n"）；
}
} catch （UnsupportedEncodingException e） {
e.printStackTrace（）；
} catch （IOException e） {
e.printStackTrace（）；
}finally{
try {
if（isr!=null）
isr.close（）；
} catch （IOException e） {
System.out.println（"流關閉是異常"）；
e.printStackTrace（）；
}
}
return sb;
}
/**
* @return
* @throws Exception
* 獲取雲空間的信息
*/
public CloudInfo getCloudInfo（） throws Exception {
URL u = new URL（"?method=info&access_token=你申請的token的值";
URLConnection conn = u.openConnection（）；// 打開網頁鏈接
// 獲取用戶雲盤信息
String cloudJson = this.getJsonString（conn）。toString（）；
// 解析成對象 下面有這個實體對象的類
Gson gson = new Gson（）；
CloudInfo cloudInfo = gson.fromJson（cloudJson, CloudInfo.class）；
System.out.println（"雲盤信息："+cloudInfo）；
return cloudInfo;
}
/**
* @param URLConnection conn通過get方式獲取StringBuffer
* @return
*/
private StringBuffer getJsonString（URLConnection conn） {
InputStreamReader isr = null;
BufferedReader br = null;
StringBuffer sb = null;
try {
isr = new InputStreamReader（conn.getInputStream（），"gb2312"）；
br = new BufferedReader（isr）；
String line = null;
sb = new StringBuffer（）；
while （（line = br.readLine（）） != null） {
sb.append（line）；
sb.append（"\r\n"）；
}
} catch （UnsupportedEncodingException e） {
e.printStackTrace（）；
} catch （IOException e） {
e.printStackTrace（）；
}finally{
try {
if（isr!=null）
isr.close（）；
} catch （IOException e） {
System.out.println（"流關閉是異常"）；
e.printStackTrace（）；
}
}
return sb;
}
/**
* @return
* @throws Exception
* 獲取雲空間的信息
*/
public CloudInfo getCloudInfo（） throws Exception {
URL u = new URL（"?method=info&access_token=你申請的token的值";
URLConnection conn = u.openConnection（）；// 打開網頁鏈接
// 獲取用戶雲盤信息
String cloudJson = this.getJsonString（conn）。toString（）；
// 解析成對象 下面有這個實體對象的類
Gson gson = new Gson（）；
CloudInfo cloudInfo = gson.fromJson（cloudJson, CloudInfo.class）；
System.out.println（"雲盤信息："+cloudInfo）；
return cloudInfo;
}
[html] package com.entity;
import java.lang.reflect.Type;
/**
* @author ydcun 獲取雲空間的信息 例如：
* {"quota":123794882560, 空間配額，單位為位元組
* "used":83573494688, 已使用空間大小 單位為位元組。
* "request_id":2853739529}
*/
public class CloudInfo{
private Double quota;
private Double used;
private Double request_id;
/**
* @return the quota 空間配額，單位為位元組
*/
public Double getQuota（） {
return quota;
}
/**
* @param quota the quota to set 空間配額，單位為位元組
*/
public void setQuota（Double quota） {
this.quota = quota;
}
/**
* @return the used 已使用空間大小 單位為位元組
*/
public Double getused（） {
return used;
}
/**
* @param used the used to set 已使用空間大小 單位為位元組
*/
public void setused（Double used） {
this.used = used;
}
/**
* @return the request_id
*/
public Double getRequest_id（） {
return request_id;
}
/**
* @param request_id the request_id to set
*/
public void setRequest_id（Double request_id） {
this.request_id = request_id;
}
@Override
public String toString（） {
return new StringBuffer（）。append（"空間容量："）。append（this.getQuota（）/1024/1024）。append（"M; 已用："）。append（this.getused（）/1024/1024）。append（"M; "）。toString（）；
}
}
package com.entity;
import java.lang.reflect.Type;
/**
* @author ydcun 獲取雲空間的信息 例如：
* {"quota":123794882560, 空間配額，單位為位元組
* "used":83573494688, 已使用空間大小 單位為位元組。
* "request_id":2853739529}
*/
public class CloudInfo{
private Double quota;
private Double used;
private Double request_id;
/**
* @return the quota 空間配額，單位為位元組
*/
public Double getQuota（） {
return quota;
}
/**
* @param quota the quota to set 空間配額，單位為位元組
*/
public void setQuota（Double quota） {
this.quota = quota;
}
/**
* @return the used 已使用空間大小 單位為位元組
*/
public Double getused（） {
return used;
}
/**
* @param used the used to set 已使用空間大小 單位為位元組
*/
public void setused（Double used） {
this.used = used;
}
/**
* @return the request_id
*/
public Double getRequest_id（） {
return request_id;
}
/**
* @param request_id the request_id to set
*/
public void setRequest_id（Double request_id） {
this.request_id = request_id;
}
@Override
public String toString（） {
return new StringBuffer（）。append（"空間容量："）。append（this.getQuota（）/1024/1024）。append（"M; 已用："）。append（this.getused（）/1024/1024）。append（"M; "）。toString（）；
}
}
2.通過post方式提交 我用上傳單個文件為例子：
同樣我們也先了解下上傳文件要參數設置：
請求參數：
url: 標明我們要訪問的網址路徑 值固定問""
method:標明我們是請求雲盤信息 值固定為"upload"
acceess_token:准入標識 值是我們自己申請的
path:是我們要上傳到雲盤的那個路徑下 如/apps/myBaiCloud/ myBaiCloud是我們的應用名稱（當你獲取koten後就會自動生成以你應用名稱為名的文件夾）
file:這個就是我們要上傳的文件了（要求用post方式上傳）
onp:可選參數，標識當有重名的文件的時候處理方式具體見api
接收返回參數：
返回的也是json串，
path:為我們上傳的文件保存的全路徑
size:文件的大小有多少位元組
ctime/mtime:文件的創建修改時間
其他參數介紹點小標題去api中查看
{
"path" : "/apps/album/README.md"
"size" : 372121,
"ctime" : 1234567890,
"mtime" : 1234567890,
"md5" : "cb123afcc12453543ef",
"fs_id" : 12345,
"request_id":4043312669
}
我在做的時候也是將其封裝到實體類中了，這里和上面一樣不詳述，我們重點看下提交文件是怎麼提交的代碼如下：
[java] /**
* @param path 雲盤存放路徑
* @param name 要上傳的文件
* @return
* @throws Exception
*/
public FileBase uploadFile（String path,File file） throws Exception{
//模擬文件
String fileName="README.md";
file = new File（fileName）；
path="%2fapps%2fmy%2f"; // 我用的是url編碼過源碼為：-> "/apps/my/
/"
//將需要url傳值的參數和url組裝起來
String u =""+path+file.getName（）+"&method=upload&access_token=你自己申請的token值";
PostMethod filePost = new PostMethod（u）；
//post提交的參數
Part[] parts = {new FilePart（fileName,file）};
//設置多媒體參數，作用類似form表單中的enctype="multipart/form-data"
filePost.setRequestEntity（new MultipartRequestEntity（parts, filePost.getParams（）））；
HttpClient clients = new HttpClient（）；
//響應代碼
int status = clients.executeMethod（filePost）；
System.out.println（"成功上傳"+path+fileName）；
BufferedReader buReader = new BufferedReader（new InputStreamReader（filePost.getResponseBodyAsStream（），"utf-8"））；
StringBuffer sb = new StringBuffer（）；
String line;
while（（line=buReader.readLine（））！=null）{
sb.append（line）；
}
buReader.close（）；
// 解析成對象
Gson gson = new Gson（）；
FileBase cloudInfo = gson.fromJson（sb.toString（）， FileBase.class）；
return cloudInfo;
}
/**
* @param path 雲盤存放路徑
* @param name 要上傳的文件
* @return
* @throws Exception
*/
public FileBase uploadFile（String path,File file） throws Exception{
//模擬文件
String fileName="README.md";
file = new File（fileName）；
path="%2fapps%2fmy%2f"; // 我用的是url編碼過源碼為：-> "/apps/my/
/"
//將需要url傳值的參數和url組裝起來
String u =""+path+file.getName（）+"&method=upload&access_token=你自己申請的token值";
PostMethod filePost = new PostMethod（u）；
//post提交的參數
Part[] parts = {new FilePart（fileName,file）};
//設置多媒體參數，作用類似form表單中的enctype="multipart/form-data"
filePost.setRequestEntity（new MultipartRequestEntity（parts, filePost.getParams（）））；
HttpClient clients = new HttpClient（）；
//響應代碼
int status = clients.executeMethod（filePost）；
System.out.println（"成功上傳"+path+fileName）；
BufferedReader buReader = new BufferedReader（new InputStreamReader（filePost.getResponseBodyAsStream（），"utf-8"））；
StringBuffer sb = new StringBuffer（）；
String line;
while（（line=buReader.readLine（））！=null）{
sb.append（line）；
}
buReader.close（）；
// 解析成對象
Gson gson = new Gson（）；
FileBase cloudInfo = gson.fromJson（sb.toString（）， FileBase.class）；
return cloudInfo;
}
上面代碼成功後我們就會在/apps/my/目錄下找到README.md文件
commons-codec-1.3.jar
commons-
commons-logging.jar
gson-2.2.1.jar
jsoup-1.6.3.jar
❹ 怎樣使用百度地圖web api文檔
網路地圖官網API上面怎麼導入JAR包，導入哪個jar包，怎麼調用jar包等等，有各種各樣的實例，按照實例來就可以了~怎樣使用網路地圖web api文檔
❺ 如何使用api
用於在模塊級別中聲明對動態鏈接庫 (DLL) 中外部過程的引用。
語法 1
[Public | Private] Declare Sub name Lib "libname" [Alias "aliasname"] [([arglist])]
語法 2
[Public | Private] Declare Function name Lib "libname" [Alias "aliasname"] [([arglist])] [As type]
Declare 語句的語法包含下面部分：
部分
描述
Public
可選的。用於聲明對所有模塊中的所有其它過程都可以使用的過程。
Private
可選的。用於聲明只能在包含該聲明的模塊中使用的過程。
Sub
可選的（但 Sub 或 Function
二者需選其一）。表示該過程沒有返回值。
Function
可選的（但 Sub 或 Function
二者需選其一）。表示該過程會返回一個可用於表達式的值。
name
必需的。任何合法的過程名。注意動態鏈接庫的入口處（entry points）區分大小寫。
Lib
必需的。指明包含所聲明過程的動態鏈接庫或代碼資源。所有聲明都需要 Lib
子句。
libname
必需的。包含所聲明的過程動態鏈接庫名或代碼資源名。
Alias
可選的。表示將被調用的過程在動態鏈接庫 (DLL)
中還有另外的名稱。當外部過程名與某個關鍵字重名時，就可以使用這個參數。當動態鏈接庫的過程與同一范圍內的公用變數、常數或任何其它過程的名稱相同時，也可以使用
Alias。如果該動態鏈接庫過程中的某個字元不符合動態鏈接庫的命名約定時，也可以使用 Alias。
aliasname
可選的。動態鏈接庫或代碼資源中的過程名。如果首字元不是數字元號 (#)，則
aliasname 是動態鏈接庫中該過程的入口處的名稱。如果首字元是
(#)，則隨後的字元必須指定該過程的入口處的順序號。
arglist
可選的。代表調用該過程時需要傳遞的參數的變數表。
type
可選的。Function 過程返回值的數據類型；可以是 Byte、布爾、Integer、Long、Currency、Single、Double、Decimal（目前尚不支持）、Date、String（只支持變長）或 Variant，用戶定義類型，或對象類型。
比如我要使用sendmessage這個API函數，可以這樣寫：
Public Declare Function SendMessage Lib "user32" Alias "SendMessageA" (ByVal hwnd As Long, ByVal wMsg As Long, ByVal wParam As Long, lParam As Any) As Long
VB有個API瀏覽器，裡麵包含很多WIN32 API函數 可以從VB的外接程序-外接程序管理器-vb6 api viewer選擇
❻ 怎麼使用API文檔
如果英語水平好的話，建議使用英文版的API。請問你說的是什麼API呢？JAVA的?C++的?Android的？不過都很容易使用，就像字典一樣，查詞語語法，意思，怎麼樣用。
❼ 如何使用百度地圖API
網路地圖API
開始學習網路地圖API最簡單的方式是看一個簡單的示例。以下代碼創建了一個520x340大小的地圖區域並以天安門作為地圖的中心:
1. <html>
2. <head>
3. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
4. <title>Hello, World</title>
5. <script type="text/javascript" src="http://api.map..com/api?key=&v=1.0&services=false"></script>
6. </head>
7. <body>
8. <div style="width:520px;height:340px;border:1px solid gray" id="container"></div>
9. </body>
10. </html>
11.
12.
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Hello, World</title>
<script type="text/javascript" src="http://api.map..com/api?key=&v=1.0&services=false"></script>
</head>
<body>
<div style="width:520px;height:340px;border:1px solid gray" id="container"></div>
</body>
</html>
1. <script type="text/javascript">
2. var map = new BMap.Map("container"); // 創建地圖實例
3. var point = new BMap.Point(116.404, 39.915); // 創建點坐標
4. map.centerAndZoom(point, 15); // 初始化地圖，設置中心點坐標和地圖級別
5. </script>
6.
<script type="text/javascript">
var map = new BMap.Map("container"); // 創建地圖實例
var point = new BMap.Point(116.404, 39.915); // 創建點坐標
map.centerAndZoom(point, 15); // 初始化地圖，設置中心點坐標和地圖級別
</script>
引用網路地圖API文件
當您引用地圖API文件時，需要使用自己申請的API密鑰。
1. <script type="text/javascript" src="http://api.map..com/api?key=&v=1.0&services=false"></script>
<script type="text/javascript" src="http://api.map..com/api?key=&v=1.0&services=false"></script>
創建地圖容器元素
1. <div style="width:520px;height:340px;border:1px solid #000" id="container"></div>
<div style="width:520px;height:340px;border:1px solid #000" id="container"></div>
地圖需要一個HTML元素作為容器，這樣才能展現到頁面上。這里我們創建了一個div元素並制定它的大小。地圖會根據容器大小調整自身尺寸。
命名空間
API使用BMap作為命名空間，所有類均在該命名空間之下，比如：BMap.Map、BMap.Control、BMap.Overlay。
創建地圖實例
1. var map = new BMap.Map("container");
var map = new BMap.Map("container");
位於BMap命名空間下的Map類表示地圖，通過new操作符可以創建一個地圖實例。其參數可以是元素id也可以是元素對象。
注意在調用此構造函數時應確保容器元素已經添加到地圖上。
創建點坐標
1. var point = new BMap.Point(116.404, 39.915);
var point = new BMap.Point(116.404, 39.915);
這里我們使用BMap命名空間下的Point類來創建一個坐標點。Point類描述了一個地理坐標點，其中116.404表示經度，39.915表示緯度。
地圖初始化
1. map.centerAndZoom(point,15);
map.centerAndZoom(point,15);
在創建地圖實例後，我們需要對其進行初始化，BMap.Map.centerAndZoom()方法要求設置中心點坐標和地圖級別。
地圖必須經過初始化才可以執行其他操作。
地圖操作
地圖被實例化並完成初始化以後，就可以與其進行交互了。API中的地圖對象的外觀與行為與網路地圖網站上交互的地圖非常相似。它支持滑鼠拖拽、滾輪縮放、雙擊放大等交互功能。您也可以修改配置來改變這些功能。
您還可以通過編程的方式與地圖交互。Map類提供了若干修改地圖狀態的方法。例如：setCenter()、panTo()、zoomTo()等等。
下面示例顯示一個地圖，等待兩秒鍾後，它會移動到新中心點。panTo()方法將讓地圖平滑移動至新中心點，如果移動距離超過了當前地圖區域大小，則地圖會直跳到該點。
1. var map = new BMap.Map("container");
2. var point = new BMap.Point(116.404, 39.915);
3. map.centerAndZoom(point, 15);
4. window.setTimeout(function(){
5. map.panTo(new BMap.Point(116.409, 39.918));
6. }, 2000);
var map = new BMap.Map("container");
var point = new BMap.Point(116.404, 39.915);
map.centerAndZoom(point, 15);
window.setTimeout(function(){
map.panTo(new BMap.Point(116.409, 39.918));
}, 2000);
原文：http://www.cnblogs.com/xuhongfei/archive/2013/04/10/3011964.html
❽ Java學習中，如何使用api文檔，api文檔不知道如何使用該怎麼辦
api 就是用網頁製作的 就像字典一樣的東西有目錄 有搜索 這里有java api 中文1.6版下載地址：http://dl.vmall.com/c0e9j08pee
❾ 什麼是百度統計API怎麼用
API（Application Programming Interface,應用程序編程介面）是一些預先定義的函數，目的是提供應用程序與開發人員基於某軟體或硬體的以訪問一組常式的能力，而又無需訪問源碼，或理解內部工作機制的細節。
網路推廣API是網路推廣平台對外開放的一系列應用程序介面，目前包含了網路搜索推廣API和網路網盟推廣API。
開發人員能夠通過調用網路推廣API與網路推廣平台直接交互，基於API開發一系列的自己獨有的應用程序，並使用應用程序管理推廣賬戶的推廣物料，下載推廣賬戶的數據報告，了解推廣賬戶的物料狀態。
您可以將API理解為通過應用程序來管理您的網路推廣賬戶的方式。當然，您也可以使用程序管理的同時，同時進行人工管理，兩者合理搭配以達到最佳的效果。
網路推廣API擁有自己的官方網站：apihome..com，您可以在該網站上了解到更多關於網路推廣API的相關內容。
為了使用網路推廣API，您需要開發程序來管理您的網路推廣賬戶。
這一過程需要熟悉程序開發語言及Web Service、SOAP和HTTPS方面的知識的開發人員，並需要對於對應的網路推廣業務系統有一定程度的了解。
具體的開發文檔請參考我們的官方網站的開發文檔頁面。
更多問題，請到推廣客戶端幫助頻道查詢：http://yingxiao..com/support/editor/index.html
了解更多網路推廣信息，請查看：http://e..com/或撥打售前咨詢電話：400-800-8888。
❿ 如何使用百度api store
1
搜索引擎中搜索網路 api store，找到網路 api store的官網，進入官網
2
打開官網後，首頁展示各種api服務及常用的api服務
3點擊導航欄中的api服務或者首頁查看全部，進入api分類列表頁面
4以數據服務-->生活常用為例。進入相關生活常用的api服務列表
5選擇我們常用的IP地址查詢的api，
6點擊進入IP地址查詢頁面，點擊頁面中的api頁簽
7進入api頁面，找到去調試 鏈接
8輸入你需查詢的ip，就可以查詢出ip的詳細信息