上篇写了个大概,今天我详细说一下参数的编辑,废话不多说
先打开一个项目,我要特别说一下设置里的“默认参数设置”
打开默认参数设置,设置完成后会在新建接口的时候自动填入定义好的参数
注意:只对新建的接口有用,对之前的接口和复制的接口无效
红色圈出的tab可以设置请求头,返回头和返回状态我这里设置一下请求头和返回状态,保存
设置请求头 设置返回状态接下来开始新建接口
点击新增接口默认参数已经填入了
默认参数已经被填入填入详细信息,保存
输入接口基本信息新建接口时并没有填写请求参数和返回参数,所以界面上会提示继续完善
没有填写请求参数和返回参数点击编辑或请求Class说明旁边的按钮,可以回到编辑界面,请求和返回Class就出现了,特别介绍下设置父Class,可以大大减少将来维护接口文档和修改代码的工作量
Class编辑点击设置父Class,会弹出Class设置的页面,圈出的“是否是内部Class”的选项表示是否有其它接口会用到这个Class,不勾就会显示在选择外部Class的列表中
父Class编辑点击“选择外部Class”,出现外部Class的列表,可以很方便的引用
注意1:虽然外部Class使用方便并且可以到处引用,但还是强烈建议减少使用外部Class(如果外部Class太多,这个列表会很长,找起来比较麻烦)
注意2:这里删除按钮必须是引用计数为0才会出现,应该是出于防止误删的考虑吧
点击引用按钮选择其中一个来使用,然后直接保存
点击引用后,参数自动填入这样父Class就设置好了,回到第一个参数编辑的页面,可以看到从父Class继承的参数已经填好,并且在这个页面是不能修改的。
注意1:当父Class被修改,这里的继承的参数也会自动被修改,维护就方便了很多
注意2:角上的减号可以直接删除自己的父Class,父Class的参数也会被一起删除
保存一下我们的接口,这里有个提示,其实是因为返回Class并没有设置,设置完了就不会有提示了
返回Class并没有设置这里有我最终生成的文档
圈出5个Class生成-->生成代码-->Java-->Gson
生成的代码一下就写好5个Class, 还带注释
好了,搞接口去了,强烈要求请求返回都能生成,牛逼的程序员都应该是只搞逻辑的,琐事就应该是自动生成的
下次更新会介绍API管家的测试功能
网友评论