第一个接口的完成

这是我进入公司实习的第一个月零两个星期,我完成了在公司的第一个接口。怎么说呢兴奋的同时也终于理解了在公司工作的流程以及一些事项,从刚开始接口是什么都模糊不清,到现在可以完成接口。虽然这个接口相对来说比较简单没有一些非常复杂的技术,但我还是很欣慰,接下来的这个文章主要用来总结一个接口是通过怎样完成的
这里忽略了前期的分析会等等,只说如何实现


实现接口前的准备(看老代码)

阅读之前的代码,在看懂逻辑的前提下,找出可以直接用的方法或接口等。例如封装json、解码jaon、调用接口等之前写好的接口。(这里我接到的需求是在原基础上进行一个性能的优化还由于是新手,所以许多的方法没有进行修改而是选择直接复用)
(1)如何找到接口:https://blog.csdn.net/hzw_mvp/article/details/103351647
(2)这就可以去项目代码中搜索:右键项目的src —> Find in path —> 搜索需要的即可(或者快捷键 :ctrl+shift+f)

接口实现

1.看明白需求之后就可以开动了(这里我自己新添加了一个接口,下面来说说这个接口是如何实现的)
(1)创建参数结构体(这里面是你需要传入接口的参数)
(2)创建返回的结构体(个人习惯把两个结构体放在最上面)
(3)新建出参数结构体之后解码json(别忘了判错)
(4)按照逻辑,完成接口所需要完成的内容
(5)封装json并返回
注意:返回的结构体中一般分为code、runtime、msg、data。其中data中就是你要返回的结构体(用map)
2.当你写完接口之后要检查你的配置文件中的地址等针对于个人的信息,修改为你需要的信息之后就可以启动程序,再进行自测啦(这里我用到的是postman)
3.自测通过后,写上接口文档就阔以啦~~~~~~

调试接口

在我调试接口的时候用到的最多的两个方法第一debug、第二一步一步打印
1.debug:打断点的方式进行调试,不用多说大家应该都动,但是我学艺不精所以通常采用下面的方法
2.在我的接口中,不同文职fmt11111、fmt2222等,我就可以清楚的看出程序的走向,再根据是否按照原本的路线走等一些情况来处理这些问题。

这里总结一下我遇到的问题:
(1)仔细看看之前写的方法,因为有些时候并不是都可以用的。例如:在我写代码的时候复用的方法查询过后返回的是一个nil,而我则想取查询值的email,我则直接.emal系统报错空指针,因为nil.xxxx就是会报错
(2)调用其他接口的时候,先测试被调用的接口是否正确。最后再测试待完成接口是否正确
(3)最后一点还是要重复提的就是一定要 看明白代码,好多时候我都是错误出现才去阅读之前的代码。很多时候根本就是一问三不知的蒙头写,这样是不行的。

推荐阅读更多精彩内容