发表于: 2017-06-21 23:30:39

1 1096


今天完成的事情:
wiki上看了了晓进姐写的接口规范,其中需要注意的是
1、请求参数和返回参数度分为5列:字段,说明,类型,备注,是否必填
字段是类的属性;说明是中文释义;类型是属性类型,只有String ,Number,Object,Arrary四种类型;备注是一些解释,或者可以写一下例子,比如负责json结构的情况,最好写上例子,最好让前端更好的理解,是否必填是字段的是否必填。

2、返回参数结构有几种情况:

      1.如果返回接口调用成功还是失败(如新增,删除,修改等),则有一个结构体:code和message两个参数;

      2.如果要返回某些参数,则有两个结构体:

           1是code/mesage/data,2是data里写返回的参数,data是object类型;

     3.如果要返回列表,那么有三个结构体:

          1是code/message/data,data是object,里面放置page/size/total/totalPage/list5个参数其中list是Arrary类型,list里放object,object里是具体的参数。

3、约定的数据,数据库用int,java用integer。比如状态status,1-上架;2-下架。
4、url:需要登录才能调用的接口用的需要加/u;查询列表,那么以/search结尾。

ps:url中不允许出现大写字母,如果是两个单词拼接,用/分开(为什么萝卜多的官网url里面有大写字母?)

按照规范,修改了我的接口文档。
下午听了师姐为我们讲解代码自动生成,还有魏杨师兄小课堂上也讲了自动生成代码,自己测试代码成功生成,test里面到了一堆的包,之后还是有报错,然后将生成的代码中都导包,只有tuscany的包导不上去

点击add还是导不进去。今天就到这里了,感觉离成功只有一步了。


明天计划的事情:

解决代码生成的问题,写方案设计。


遇到的问题:

上面写了,导包到不进去。


收获:
看了接口规范,才发现自己写的接口文档中的问题,以及要修改的地方。接着改。







返回列表 返回列表
评论

    分享到