关于接口设计怎么写，接口设计方案这个很多人还不知道，今天小柳来为大家解答以上的问题，现在让我们一起来看看吧！
接口设计怎么写 接口设计方案
接口设计怎么写 接口设计方案
接口设计怎么写 接口设计方案
1、本接口设计规范，参考了restfull的部分设计理念。
2、资源是 Restful API 的核心元素，所有的作都是针对特定资源进行的。
3、任何事物，只要有被引用到的必要，它就是一个资源。
4、资源可以是实体(例如手机号码)，也可以只是一个抽象概念(例如价值) 。
5、下面是一些资源的例子：Github 可以说是这方面的，下面我们就拿 reitory 来说明。
6、我们可以看到几个特性：接口名称应简单明了，望文知意，接口中，需描述清楚接口的具体业务功能。
7、原则上，接口命名规范整体采用“名词”+“动词”形式接口返回或者作的是单个资源对象，采用名称的单数形式命名，如：/user/add，/user/del，/user/get接口返回或者作的是多个资源对象，采用名称的复数形式命名，如：/users/get针对同一个接口，根据实际业务需求，为解决接口兼容性问题，可以对接口进行版本扩展，命名规范为“名词”+“动词”+“版本号”形式，版本号采用v1、v2、v3形式命名例：/user/login ，/user/login/v1接口返回值，将统一采用如下格式：{"sign": "f64b967289ac4d8cbfdc22ad30ec9d09","content": "{}","timestamp": 1561204602005,"desc": "成功!","code": "000","accessToken": "83BAED4DAE9DEF783FDE243F4B5C"}sign:返回值签名验签（如果需要）如遇第三方合作等特殊情况，根据实际情况进行设计。
8、一个接口只做一件事情连字符"-"一般用来分割URI中出现的字符串(单词)，来提高URI的可读性，使用下划线"_"来分割字符串(单词)可能会和链接的样式冲突重叠，而影响阅读性。
9、根据RFC3986定义，URI是对大小写敏感的，所以为了避免歧义，我们尽量用小写字符。
10、例，针对金额，都统一为amount，而不是有的amount，有的money。
11、如是对老接口进行改动，需考虑接口的兼容性，包括字段的增减、字段名称调整、字段类型的调整、字段值内容长度的调整，字段值取值范围的调整等。
12、接口一旦发布就不易修改，要保持兼容性，拼写错误也不能改了，所以要仔细检查拼写。
13、悲剧：unix 的 creat。
14、creat是一个函数，可以用来创建一个文件并以只写的方式打开。
15、参数命名是定语+名词比如 fileName, maxSize, textColor，而不是用name、size、colour不要用生僻单词，也不要用汉语拼音除非是约定俗成已经被广泛使用的缩写，否则老老实实用完整拼写。
16、比如 有open就要有close，有login就要有logout，这些单词基本是固定搭配的，使用者就很容易理解。
17、例，业务需要vip用户，接口不允许设计为isVipUser，而应该设计为获取用户的会员等级接口，/user/ll/get，这样保证接口的通用性和扩展性分页相关接口参数命名统一：pageSize:每页记录条数pageNum:当前页数totalPageNum:总共页数统一以分为单位进行传递建议统一以时间毫秒数进行传递，避免前后端或者各种场景下日期格式不统一。
本文到这结束，希望上面文章对大家有所帮助。