甜橘子，专注成都网站制作网站设计与营销型网站建设与优化
QQ :532337155
电话：028-86922220
一些刚开始写接口文档的服务端同学，很容易按着代码的思路去编写接口文档，这让客户端同学或者是服务对接方技术人员经常吐槽，看不懂接口文档。这篇文章提供一个常规接口文档的编写方法，给大家参考。
成都创新互联的客户来自各行各业，为了共同目标，我们在工作上密切配合，从创业型小企业到企事业单位，感谢他们对我们的要求，感谢他们从不同领域给我们带来的挑战，让我们激情的团队有机会用头脑与智慧不断的给客户带来惊喜。专业领域包括网站设计制作、做网站、电商网站开发、微信营销、系统平台开发。
推荐使用的是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，支持团队项目管理。
套接字 Socket
import java.net.*;
Server:
ServerSocket server=new ServerSocket(port);//port是端口
Socket socket=server.accept();
//等待客户机的连接请求，若连接，则创建一套接字，并将返回。
Client:
Socket socket=new Socket("host",port);//host主机名（本机：127.0.0.1）
两边是通过接口来交换信息的，当然都需要接口和它的 Stub。
你做实验时可以考虑创建3个项目：
1、接口项目，只包括接口和接口编译后的 Stub 类
2、服务端项目，只包括服务器类，它依赖接口项目。
3、客户端项目，只包括客户端，它依赖接口项目。
如果是从命令行运行它们，那么服务端需要服务端项目和接口项目两个 jar，客户端需要客户端项目和接口项目两个 jar，我们需要面向接口编程减少耦合程度，不要把所有类全部放在同一个项目中编译，将来会碰到很多麻烦事，比如包名太多就可能不支持 OSGi 这种方式。
在远程调用类的应用中，使用静态方法调用时一般需要接口类对应的Stub，我们 lookup 得到的其实是 Stub （它只包括了连接到服务器的参数，然后把你想调用的”服务“ + ”参数“ 发送给服务器并将从服务器返回的结果返回给客户端程序，因此，它其实并没有什么”针对你的程序和服务器的特殊特性），使用动态的调用方式就完全可以做到不需要特定的 Stub 而用一个通用的方式 （也就是 RMI 编译生成的那个 Stub 类的内容我们来自己写成一个框架。
上面一段是废话，来说说怎么配置环境测试它们。
客户端项目中只需要有接口 TestServer 和 TestServerStub 两个类，如果你的参数本身也是一个 Remote 子类，那么参数类也需要有相应的 Stub。
另外，我们客户端也可以仅自带接口类而不自带Stub，在运行的时候可以”请求从服务器上下载一份 Stub"，如下：
System.setSecurityManager(new RMISecurityManager());
然后在命令行添加额外参数:
-Djava.security.policy=$policy 文件
-Djava.rmi.server.codebase=
这样就可以启用 RMI Class Loader 来自动从 codebase 对应的地方查找 Stub 类，这里面 codebase 可以是一个 Http 或 Ftp 协议，注意这个 codebase URL 后面一个 / 是必须的。那个 $policy 文件可以用 JDK\bin\policytool.exe 来生成一个。