本文目录一览：
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，支持团队项目管理。
java接口怎么写
public interface A{
public void a(int x);
}
public class MyA implements A{
public void a(int x) {
System.out.println(x);
}
}
//接口是一个抽象类型，是抽象方法的集合，接口通常以interface来声明；
如有帮助请采纳(不懂请提问)，可以看我主页，欢迎来交流学习；
Java中的接口怎么实现?
举个面积的例子：在java中，定义一个接口，声明计算长方形面积和周长的抽象方法，再用一个类去实现这个接口，再编写一个测试类去使用这个接口。首先，接口必须单独存放，如果我们用eclipse编程的话，它们提示：The public type **** must be defined in its own file，意思是必须要定义在其自己的文件中，所以要为接口文件单独存放起来，举例，我们的接口要实现获到矩形的长，宽，面积，周长，所以定义以下的接口。public interface calrect {\x0d\x0apublic abstract int calarea();\x0d\x0apublic abstract int calgirth();\x0d\x0apublic abstract int getx();\x0d\x0apublic abstract int gety();\x0d\x0a}注意，定义接口就像定义类一样，接口的访问控制符只能用public，用public定义的接口可以被所有的类和包引用，而缺省的则只能被同一个包中的其他类和接口引用，这符合JAVA中访问控制符的一般要求，关于接口再引用其他接口则是后话。以上接口文件名为calrect.java.另外需要指出的是接口中不能给方法给出方法体。接下来，需要定义一个类来实现接口，因为不知道JAVA的内置矩形类是什么名，所以为了安全，将该类定义为RRect，这可以认为是一种安全策略。关于implements，可以参考其他资料。该类引用了接口calrect，所以必须对calrect中的方法一一实现。//定义矩形类 应用接口class RRect implements calrect{private int x;\x0d\x0aprivate int y;public RRect (){\x0d\x0a x=3;y=4;\x0d\x0a}\x0d\x0apublic int calarea(){\x0d\x0a return x*y;\x0d\x0a}\x0d\x0apublic int calgirth(){\x0d\x0a return x*2+y*2;\x0d\x0a}\x0d\x0apublic int getx(){\x0d\x0a return x;\x0d\x0a}\x0d\x0apublic int gety(){\x0d\x0a return y;\x0d\x0a}\x0d\x0a}//接下来，定义一个测试类，所谓测试类，我理解为定义一个类，在其定义类RRect的对象，并验证其中的方法，看看是不是可以正常使用//定义Class1类\x0d\x0apublic class Class1{\x0d\x0aRRect rect;\x0d\x0apublic static void main(String []args){\x0d\x0a RRect rect=new RRect();\x0d\x0a System.out.println("矩阵的长"+ rect.getx());\x0d\x0a System.out.println("矩阵的宽"+ rect.calarea());\x0d\x0a System.out.println("矩阵的面积"+ rect.calarea());\x0d\x0a System.out.println("矩形的周长 "+rect.calgirth());\x0d\x0a}\x0d\x0a\x0d\x0a}运行结果：矩阵的长3\x0d\x0a矩阵的宽12\x0d\x0a矩阵的面积12\x0d\x0a矩形的周长 14注：接口单存放，接口实现类和测试类可以存放在一个文件中
java如何写一个接口？
非常简单，基础语法：
public interface 接口名 {
常量定义;
抽象方法定义；
default 方法定义；
}
即使你在接口中不定义任何方法，也是可以的。
