在互联网发展的今天，作为后台程序员写api接口是必不可少的，那么怎么样设计才是一个可用灵活高效的接口呢？

首先在设计app接口之前我们应该考虑几个问题

1，如何鉴权？　

2，api格式如何？

3，如何加入版本信息方便版本的兼容和过度呢？

文档

文档和API本身一样重要。文档应该容易找到，并且公开。文档应该有展示请求和输出的例 子,请求的参数列表，适用于版本号是多少。如果有更新（特别是公开的API），应该及时更新文档。文档中应该有 关于何时弃用某个API的时间表以及详情。

 

版本化

在API上加入版本信息可以有效的防止用户访问已经更新了的API，同时也能让不同主要版本之间平稳过渡。关于是否将版本信息可以放入url或者请求头中。完整的文档和合理的时间表都会使得API使用者使用的更加轻松。

结果过滤，排序，搜索：

url最好越简短越好，和结果过滤，排序，搜索相关的功能都应该通过参数实现(并且也很容易实现)。

通常接口中常带的参数名称：

fields：返回数据字段

sortby：按字段排序

order：升序还是

page：页码

pagesize：页码数

ver：版本号