API规范.md

API规范用途

###API规范用途 web应用开放的时候，常常同一个功能模块多个人开发。最常见的情况是前后端的工程师的合作，想象一个这样才场景 现在需要实现一个登录的功能，

• 登录的时候，表单提交的url 是怎么样的，
• 需要传递什么参数，
• 密码错误时，用户被禁止登录时返回的状态码是怎么样的
• 密码错误尝试次数太多 这些情况，如果不事先约定好一些状态码或者请求的url,前后端的交互就变变得很混乱，开放之前的API接口定义就变得 尤为重要。

###优点

• 清晰的请求和数据交换格式
• 编写API文档的同时，软件流程逻辑也会同时梳理
• 及早地发现问题

路由API接口

####url 被请求的url地址

####url 功能描述 这个URL的功能

####请求方式 get、post、put、delete

####是否需要登录 有些url 只有再登录后才能被访问， 默认为不需要登录，

####请求参数

• name
• 是否必须
• 类型
• 说明、默认值、可选值

Example

name	是否必须	类型	说明，默认值，可选值等等
Content Cell	Content Cell	Content Cell	Content Cell

####返回结果

json、或者文本、跳转等等说明

####返回字段说明

Example

name	是否必须	类型	说明，默认值，可选值等等
Content Cell	Content Cell	Content Cell	Content Cell

参考文档：open.weibo.com