java接口怎麼寫,java接口類怎麼寫

本文目錄一覽：

1、Java新手，請教如何寫一個接口
2、java如何寫一個接口？
3、java接口文檔怎麼寫
4、java接口怎麼寫

Java新手，請教如何寫一個接口

public interface IntStack {

public void push(int x);

public int pop();

public void show();

}

public class MyIntStack implements IntStack {

private int[] arrStack;

public MyIntStack(int length) {

arrStack = new int[length];

for( int i=0;ilength;i++ )

arrStack[i]=-1;

}

public void push(int x) {

System.out.println(x);

}

public int pop() {

System.out.println(“pop”);

}

public void show(){

System.out.println(“show”);

}

java如何寫一個接口？

非常簡單，基礎語法：

public interface 接口名 {

常量定義;

抽象方法定義；

default 方法定義；

}

即使你在接口中不定義任何方法，也是可以的。

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中的數據是對象類型。則需要描述對象中字段的名稱、類型、長度、不能為空、默認值、說明。以表格的方式來表達最好。

示例：

二、響應參數

1. 響應 HTTP Body

響應body同請求body一樣，需要描述請清除數據的類型。

另外，如果服務會根據不同的http status code 返回不同的數據結構，也需要針對不同的http status code對內容進行描述。

三、接口說明

說明接口的應用場景，特別的注意點，比如，接口是否冪等、處理是同步方式還是異步方式等。

四、示例

上個示例（重點都用紅筆圈出來，記牢了）：

五、接口工具

推薦使用的是（以前叫小幺雞）寫接口文檔，方便保存和共享，支持導出PDF MARKDOWN，支持團隊項目管理。