java介面文檔模板

1. java介面文檔怎麼寫

一些剛開始寫介面文檔的服務端同學，很容易按著代碼的思路去編寫介面文檔，這讓客戶端同學或者是服務對接方技術人員經常吐槽，看不懂介面文檔。這篇文章提供一個常規介面文檔的編寫方法，給大家參考。

推薦使用的是docway寫介面文檔，方便保存和共享，支持導出PDF MARKDOWN，支持團隊項目管理。

一、請求參數

1. 請求方法

• GET

用於獲取數據

• POST

用於更新數據，可與PUT互換，語義上PUT支持冪等

• PUT

用於新增數據，可與POST互換，語義上PUT支持冪等

• DELETE

用於刪除數據

• 其他

其他的請求方法在一般的介面中很少使用。如：PATCH HEAD OPTIONS

2. URL

url表示了介面的請求路徑。路徑中可以包含參數，稱為地址參數，如**/user/{id}**，其中id作為一個參數。

3. HTTP Header

HTTP Header用於此次請求的基礎信息，在介面文檔中以K-V方式展示，其中Content-Type則是一個非常必要的header，它描述的請求體的數據類型。

常用的content-type：

• application/x-www-form-urlencoded

請求參數使用「&」符號連接。

• application/json

內容為json格式

• application/xml

內容為xml格式

• multipart/form-data

內容為多個數據組成，有分隔符隔開

4. HTTP Body

描述http body，依賴於body中具體的數據類型。如果body中的數據是對象類型。則需要描述對象中欄位的名稱、類型、長度、不能為空、默認值、說明。以表格的方式來表達最好。

示例：



五、介面工具

推薦使用的是http://docway.net（以前叫小幺雞） 寫介面文檔，方便保存和共享，支持導出PDF MARKDOWN，支持團隊項目管理。

2. java api 介面怎麼編寫

其實原理和正常的介面沒什麼區別，主要是為了規范操作。

3. java api介面文檔編寫

Java語言提供了一種強大的注釋形式：文檔注釋。可以將源代碼里的文檔注釋提取成一份系統的API文檔。我們在開發中定義類、方法時可以先添加文檔注釋，然後使用javadoc工具來生成自己的API文檔。

文檔注釋以斜線後緊跟兩個星號（/**）開始，以星號後緊跟一個斜線（*/）作為結尾，中間部分全部都是文檔注釋，會被提取到API文檔中。

自行搜索一下javadoc即可，示例如下：

/**
*類描述
*
*@author作者
*@version版本
*/
publicclassDemoClass{
	/**
	*內部屬性：name
	*/
	privateStringname;	
	
	/**
	*Setter方法
	*@returnname
	*/
	publicStringgetName(){
		returnname;
	}

	/**
	*Getter方法
	*@paramname
	*/
	publicvoidsetName(Stringname){
		this.name=name;
	}

}

4. JAVA介面，最近在學習介面，下了一個網路簡訊介面。get和post請求

get和post在服務端沒什麼區別的(spring框架或springMVC等一些框架除外)他們指的是提交請求的方式.另外,根據參數(account,password,moblie,content)直接在你的方法中調用就行,這和你調用自己寫的方法沒有什麼不同.再有,你要我們給你寫什麼????

5. java http調用介面書寫

rest介面的話可以使用

RestTemplate

Stringuri="http://example.com/hotels/1/bookings";

PostMethodpost=newPostMethod(uri);
Stringrequest=//createbookingrequestcontent
post.setRequestEntity(newStringRequestEntity(request));

httpClient.executeMethod(post);

if(HttpStatus.SC_CREATED==post.getStatusCode()){
Headerlocation=post.getRequestHeader("Location");
if(location!=null){
System.out.println("Creatednewbookingat:"+location.getValue());
}
}

api文檔參考http://static.springsource.org/spring/docs/3.1.x/spring-framework-reference/html/remoting.html#rest-client-access

6. Java介面文檔怎麼寫

你寫這個當然是讓別人調用的了 寫上注釋 再把每個參數是什麼意思類型標注下不就可以了，用javadoc功能就可以生成文檔了

7. java 介面調用，根據介面文檔寫測試，用post方法，剛怎麼做啊，有個完整的例子么

可使用android自帶的httpclient框架實現。

1. GET 方式傳遞參數
//先將參數放入List，再對參數進行URL編碼
List<BasicNameValuePair> params = new LinkedList<BasicNameValuePair>();
params.add(new BasicNameValuePair("param1", "數據")); //增加參數1
params.add(new BasicNameValuePair("param2", "value2"));//增加參數2
String param = URLEncodedUtils.format(params, "UTF-8");//對參數編碼
String baseUrl = "伺服器介面完整URL";
HttpGet getMethod = new HttpGet(baseUrl + "?" + param);//將URL與參數拼接
HttpClient httpClient = new DefaultHttpClient();
try {
HttpResponse response = httpClient.execute(getMethod); //發起GET請求
Log.i(TAG, "resCode = " + response.getStatusLine().getStatusCode()); //獲取響應碼
Log.i(TAG, "result = " + EntityUtils.toString(response.getEntity(), "utf-8"));//獲取伺服器響應內容
} catch (ClientProtocolException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}

2. POST方式 方式傳遞參數
//和GET方式一樣，先將參數放入List
params = new LinkedList<BasicNameValuePair>();
params.add(new BasicNameValuePair("param1", "Post方法"));//增加參數1
params.add(new BasicNameValuePair("param2", "第二個參數"));//增加參數2
try {
HttpPost postMethod = new HttpPost(baseUrl);//創建一個post請求
postMethod.setEntity(new UrlEncodedFormEntity(params, "utf-8")); //將參數填入POST Entity中
HttpResponse response = httpClient.execute(postMethod); //執行POST方法
Log.i(TAG, "resCode = " + response.getStatusLine().getStatusCode()); //獲取響應碼
Log.i(TAG, "result = " + EntityUtils.toString(response.getEntity(), "utf-8")); //獲取響應內容
} catch (UnsupportedEncodingException e) {
e.printStackTrace();
} catch (ClientProtocolException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}

8. 有沒有開源的java的介面文檔管理工具

有沒有開源的java的介面文檔管理工具, 有沒有開源的文檔管理系統？什麼公司開發的？

我們用的是易度文檔管理系統，這個是開源的，其他的不是很知道，好像不多，別的，

有沒有免費的文檔管理工具？

致得E6就有免費版的，很好用的，尤其是檢索很給力，你可以試試！

有免費的文檔管理工具嗎?

你去是試下：edodocs：（易度）文檔管理軟體，去網路搜一下吧。

什麼文檔管理工具好

你試試：
idoc(多可)文檔管理軟體
到網上搜一下吧，有免費版，十用戶之內的可以免費用，功能上沒有限制

我需要一個文檔管理工具

你做一個資料庫，可以實時查詢了

求專業的項目文檔管理工具?

項目文檔管理工具可以選8Manage項目管理系統，支持文檔上傳、可交付成果歸檔、文檔模板復制等，功能比較實用的

linux有什麼好的文檔管理工具嗎

CLI終端下有MidnightCommander（mc）。
GUI下有nautilus（gnome風格）、nemo、dolphin（kde風格）、thunar（xfce風格）、konqueror（kde）等等。
使用命名查看更多：

文檔管理工具的官網是什麼

我不知道為什麼？官網回答不上，您只能用谷歌直接搜索了，金櫃項目文檔管理軟體系統。其實挺想直接告訴您的，我也不知道為什麼，就是回答不上。

有沒有用python編寫的開源協同工作管理工具

不要求，但是你簡單發布的話，因為python是腳本，所以別人就一定能拿到源代碼（得到源代碼和開源不一樣）。你要不想公開你的源代碼，你可以編譯以後再發布。

9. java API 文檔中的介面方法和抽象方法，有什麼區別

對於面向對象編程來說，抽象是它的一大特徵之一。可以通過兩種形式來體現OOP的抽象：介面和抽象類。這兩者有太多相似的地方，又有太多不同的地方。很多人在初學的時候會以為它們可以隨意互換使用，但是實際則不然。今天我們就一起來學習一下Java中的介面和抽象類。 抽象方法是一種特殊的方法：它只有聲明，而沒有具體的實現。抽象方法的聲明格式為： abstract void fun(); 抽象方法必須用abstract關鍵字進行修飾。如果一個類含有抽象方法，則稱這個類為抽象類，抽象類必須在類前用abstract關鍵字修飾。因為抽象類中含有無具體實現的方法，所以不能用抽象類創建對象。抽象類就是為了繼承而存在的，如果你定義了一個抽象類，卻不去繼承它，那麼等於白白創建了這個抽象類，因為你不能用它來做任何事情。對於一個父類，如果它的某個方法在父類中實現出來沒有任何意義，必須根據子類的實際需求來進行不同的實現，那麼就可以將這個方法聲明為abstract方法，此時這個類也就成為abstract類了。在軟體工程中，介面泛指供別人調用的方法或者函數。從這里，我們可以體會到Java語言設計者的初衷，它是對行為的抽象。介面中可以含有變數和方法。但是要注意，介面中的變數會被隱式地指定為public static final變數(並且只能是public static final變數，用private修飾會報編譯錯誤)，而方法會被隱式地指定為public abstract方法且只能是public abstract方法(用其他關鍵字，比如private、protected、static、 final等修飾會報編譯錯誤)，並且介面中所有的方法不能有具體的實現，也就是說，介面中的方法必須都是抽象方法。從這里可以隱約看出介面和抽象類的區別，介面是一種極度抽象的類型，它比抽象類更加「抽象」，並且一般情況下不在介面中定義變數。

10. java項目怎麼寫功能使用說明

基本結構可以如下：介面功能說明，參數、返回結果定義，實例。