如何写好一个接口？

好一个接口？"/>

如何写好一个接口？

1. 接到需求的时候，要思考，这个需求合不合理？自己是不是清晰的知道需求让做什么？不要盲目的写代码。
2. 是用get还是post？get需要考虑请求体大小有限制。
3. 确定好输入参数，要知道接口使用的场景，比如你让调用方提供一个根本拿不到的参数，这怎么可能！
4. 确定好响应结果，要站在前端（用户）的角度去考虑。比如让你返回一个枚举类的信息，你的返回结果应该是List<Map<String, Object>>，而不是Map<String, Object>。
5. 要知道系统的整体架构，保证系统架构的统一，什么代码需要写在什么地方，逻辑之间如何联系。这样可以方便维护，看着比较爽，避免挨骂。
6. 要考虑接口在系统中是否有其他的影响。比如，系统中存在一个通过状态来判定是否执行某一个逻辑。此时，让你编写一个服务，也是执行相同的逻辑，避免接口失败时需要人工干预的情形。那你就需要考虑同步了。
7. 要考虑接口是否可扩展。比如，实现一个通过id查询某条记录的需求。此时，你需要考虑，把请求参数做成批量的，防止下次有类似的需求，减少不必要的工作量。
8. 接口要有足够的注释，方便对接。