今天完成的任务

一、准备小课堂

小课堂选的任务2深度思考：一份规范的接口文档应该包含什么内容？

1.接口文档是什么

在项目开发汇总，web项目的前后端是分离开发的。应用程序的开发，需要由前后端工程师共同定义接口，编写接口文档，之后大家都根据这个接口文档进行开发，到项目结束前都要一直维护。

2.为什么要写接口文档？

1）项目开发过程中前后端工程师有一个统一的文件进行沟通交流开发

2）项目维护中或者项目人员更迭的时候，方便后期人员查看、维护

3.回顾接口的知识

要了解接口文档的规范，首先要了解接口。接口分为四部分：方法、uri、请求参数、返回参数：

1）方法：常用的方法就是下面的四种：GET PUT POST DELETE

2）uri：以/a开头，如果需要登录才能调用的接口（如新增、修改；前台的用户个人信息，资金信息等）后面需要加/u，即：/a/u；中间一般放表名或者能表达这个接口的单词。get方法，若果是后台通过搜索查询列表，那么以/search结尾，如果是前台的查询列表，以/list结尾。uri地址里不逊于出现大写字母，如果是两个单词拼接，用/分开

3）请求参数和返回参数：请求参数和返回参数都分为：字段、说明、类型、备注、是否必填这5列。

    字段：类的属性

    说明：中文释义

    类型：属性的类型，只有String、Number、Object、Array四大类

    备注：一些解释语，或者写简单的示例

4）返回参数，要分两种情况讨论：

    只返回接口调用成功或者失败：code、reason

    返回参数：字段、类型

3.常见问题

一份规范的接口文档应该包括什么内容

4.解决方案

除了上面提到的请求方法、uri、请求参数、返回参数以外，还应该添加接口示例、接口文档版本号、版本修改内容、版本修改时间、修改人，错误代码等。

5.实战

6.扩展思考

有没有什么工具协助我们写接口文档？

有很多。比如RAP。实战演示RAP的使用。

二、远程服务器安装jetty

1.wget命令下载Jetty9.2

wget -c http://repo1.maven.org/maven2/org/eclipse/jetty/jetty-distribution/9.2.19.v20160908/jetty-distribution-9.2.19.v20160908.tar.gz

输入上面的命令按回车后，显示下载过程

2.解压，并移到/opt目录下

3.重命名

验证

4.设置新的基目录

遇到的问题

无法设置新的jetty基目录。这是之前在自己电脑装Jetty时没看懂绕过的坑，今天在远程服务器上安装Jetty又碰到这个坑了。找到资料都没有提到怎么设置JETTY_HOME的环境变量，自己往系统变量设置的环境变量又没起作用。后面请教了张鑫师兄，师兄帮我解决的设置新的jetty基目录。但还是有些问题没搞懂，打算明天再花一点时间自己研究一下，争取搞清楚搞明白。

收获

了解接口文档的作用、包含的内容，以及一个协助编写接口文档的APP

对配置jetty有了更多的了解

明天的计划

1.讲小课堂

2.用JSON Taglib实现JSON接口

进度

准备提交任务2

任务开始时间 2017.8.22

预计提交时间 2017.8.30

延期风险 已延期

禅道 http://task.ptteng.com/zentao/project-task.html