Android 开发中的接口文档

最新推荐文章于 2025-11-01 13:22:27 发布
转载 最新推荐文章于 2025-11-01 13:22:27 发布 · 1.8k 阅读 · 3

原文地址：http://blog.youkuaiyun.com/lovoo/article/details/51756120


接口文档

  1. HTTP部分
  2. Socket自定义协议

Http部分

全局规范

  • URL

    URL的组成：基本的网络地址 ＋ 分支节点

    http://127.0.0.1:8080/chat 为 基本的网络地址

    /login 为 分支节点

    http://127.0.0.1:8080/chat/login 组成完整的 URL

    当前统一的基本网络地址为 http://127.0.0.1:8080/ChatServer

  • 请求方式

    POST

    GET

    PUT

  • 请求消息头

    键值对(key value形式)

  • 请求参数

    键值对(key value形式)

  • 响应的状态码

    统一的返回码为: 200 (注:只要访问服务器成功，一律返回200)

  • 响应的格式

    Json

  • 响应的JSON规范

    • 成功

      {flag:true, data:...}

      成功的标记为 flag 为 true

      根据具体的请求，如果需要返回值 data节点 包含的是 返回结果

      不需要需要返回值 ，则没有data节点

    • 失败

      {flag:false, errorCode:1, errorString:"错误原因"}

      失败的标记为 flag 为 false

      flag 为 false时，必然返回 errorCode和errorString 节点

      errorCode说明了错误编码

      errorString说明错误原因

Login(登录接口)

  • 分支节点 : /login

  • 请求方式 : POST

  • 请求参数 :

    key类型说明
    accountString用户的账号
    passwordString用户的密码

  • 响应结果 :

    • 成功

      {
    "flag": true,
    "data": {
        "account": "zhangsan",
        "name": "张三",
        "sex": 1,
        "icon": "/a/b/zhangsan.png",
        "sign": "我的个性签名",
        "area": "深圳",
        "token": "5904c7ae-3e75-48c8-bbee-ad094533a422"
    }
}

    • 失败

      errorCodeerrorString
      100用户密码错误
      101用户不存在

Regisger(注册接口)

  • 分支节点 : /register

  • 请求方式 : POST

  • 请求参数 :

    key类型说明
    accountString用户注册的账号
    passwordString用户注册的密码

  • 响应结果 :

    • 成功

      {
    "flag": true,
    "data": {
        "account": "zhangsan",
        "name": "张三",
        "sex": 1,
        "icon": "/a/b/zhangsan.png",
        "sign": "我的个性签名",
        "area": "深圳",
        "token": "5904c7ae-3e75-48c8-bbee-ad094533a422"
    }
}

    • 失败

      errorCodeerrorString
      150用户已经存在

搜索用户接口

  • 分支节点 : /user/search

  • 请求方式 : POST

  • 请求消息头 :

    key类型说明
    accountString用户的账号
    tokenString用户的唯一标识

  • 请求参数 :

    key类型说明
    searchString搜索的账号

  • 响应结果 :

    • 成功

      {
    "flag": true,
    "data": {
        "account": "zhangsan",
        "name": "张三",
        "icon": "/a/b/zhangsan.png",
        "sign": "我的个性签名",
        "area": "深圳"
    }
}

    • 失败

      errorCodeerrorString
      200用户不存在

接受用户用户邀请

  • 分支节点 : /friend/accept

  • 请求方式 : POST

  • 请求消息头 :

    key类型说明
    accountString用户的账号
    tokenString用户的唯一标识

  • 请求参数 :

    key类型说明
    invitorString邀请者的账号
    acceptorString接受者的账号

  • 响应结果 :

    • 成功

      {
    "flag": true
}

    • 失败

      {
    "flag": false
}

获取朋友列表

  • 分支节点 : /friend/list

  • 请求方式 : POST

  • 请求消息头 :

    key类型说明
    accountString用户的账号
    tokenString用户的唯一标识

  • 请求参数 : 无

  • 响应结果 :

    • 成功

      {
    "flag": true
}

    • 失败

      {
    "flag": false
}

用户名称修改接口

  • 分支节点 : /user/nameChange

  • 请求方式 : POST

  • 请求消息头 :

    key类型说明
    accountString用户的账号
    tokenString用户的唯一标识

  • 请求参数 :

    key类型说明
    nameString修改后的用户名

  • 响应结果 :

    • 成功

      {
    "flag": true
}

    • 失败

      {
    "flag": false
}

Sokect自定义协议

全局规范

  • 协议的定义

    1. 传输格式为json
    2. 协议分为 请求 和 响应

    3. 传输方向:

      client --> server : 发送消息

      server --> client : 推送消息

    4. 发送消息

      发送过程包含的两个过程：

      请求 : client 发送消息到 server

      响应 : server 响应 client 的这次消息请求

      两个过程 都完成 才算 当前消息发送成功

    5. 推送消息

      推送过程包含的两个过程：

      请求 : server 发送消息到 client

      响应 : client 响应 server 的这次消息请求

      两个过程 都完成 才算 当前消息发送成功

    6. 消息必备格式

      请求部分:

      {
    "sequence": "9f4c696e-9ab5-46cf-959c-b1e2e35200d2",
    "type": "request",
    "action": "text"
}

      响应部分:

      {
    "sequence": "9f4c696e-9ab5-46cf-959c-b1e2e35200d2",
    "type": "response",
    "flag": "true"
}

      sequece : 标记 请求 和 响应，用来表明 响应 是 针对 哪次 请求的

      type : 用来标记 是 请求 还是 响应

      action : 请求发送方 的 发送类型，由具体请求 决定取值。

Client 部分

Auth认证

  • Action : auth

  • 请求的 key-Value

    key类型说明
    typeString请求：request
    sequenceString请求的序列号
    actionString请求的行为:auth
    senderString发送者账号
    tokenString发送者token标志

  • 请求的json 格式:

    {
    "sequence": "9f4c696e-9ab5-46cf-959c-b1e2e35200d2",
    "type": "request",
    "action": "auth",
    "sender":"xxxx",
    "token":"xxxx"
}

    {"sequence":"1","type":"request","action":"auth","sender":"iphone1","token":"0dce6f76ac1a29d276c0c6dabe60519c"}

  • 响应的json 格式:

    成功 :

    {
    "sequence": "9f4c696e-9ab5-46cf-959c-b1e2e35200d2",
    "type": "response",
    "flag": "true",
}

    失败 :

    {
    "sequence": "9f4c696e-9ab5-46cf-959c-b1e2e35200d2",
    "type": "response",
    "flag": "false",
    "errorCode":"",
    "errorString":""
}
发送邀请

  • Action : invitation

  • 请求的 key-Value

    key类型说明
    typeString请求：request
    sequenceString请求的序列号
    actionString请求的行为:invitation
    senderString发送者账号
    tokenString发送者token标志
    receiverString接收者的账号
    contentString邀请的文本内容

  • 请求的json 格式:

    {
    "sequence": "9f4c696e-9ab5-46cf-959c-b1e2e35200d2",
    "type": "request",
    "action": "invitation",
    "token":"xxxx",
    "sender":"xxxx",
    "receiver":"xxxx",    
    "content":"xxxxxx"
}

  • 响应的json 格式:

    成功 :

    {
    "sequence": "9f4c696e-9ab5-46cf-959c-b1e2e35200d2",
    "type": "response",
    "flag": "true",
}

    失败 :

    {
    "sequence": "9f4c696e-9ab5-46cf-959c-b1e2e35200d2",
    "type": "response",
    "flag": "false",
    "errorCode":"",
    "errorString":""
}
发送文本消息

  • Action : text

  • 请求的 key-Value

    key类型说明
    typeString请求：request
    sequenceString请求的序列号
    actionString请求的行为:invitation
    senderString发送者账号
    tokenString发送者token标志
    receiverString接收者的账号
    contentString邀请的文本内容

  • 请求的json 格式:

    {
    "sequence": "9f4c696e-9ab5-46cf-959c-b1e2e35200d2",
    "type": "request",
    "action": "text",
    "token":"xxxx",
    "sender":"xxxx",
    "receiver":"xxxx",    
    "content":"xxxxxx"
}

  • 响应的json 格式:

    成功 :

    {
    "sequence": "9f4c696e-9ab5-46cf-959c-b1e2e35200d2",
    "type": "response",
    "flag": "true",
}

    失败 :

    {
    "sequence": "9f4c696e-9ab5-46cf-959c-b1e2e35200d2",
    "type": "response",
    "flag": "false",
    "errorCode":"",
    "errorString":""
}

Server 部分

推送用户邀请

  • action : invitation

  • 请求的 key-Value

    key类型说明
    typeString请求：request
    sequenceString请求的序列号
    actionString请求的行为:invitation
    senderString发送者账号
    receiverString接收者的账号
    invitor_nameString邀请者的名字
    invitor_iconString邀请者的头像
    contentString邀请的文本内容

  • 请求的json 格式:

    {
    "sequence":"3",
    "type":"request",
    "action":"invitation",
    "sender":"iphone1",
    "receiver":"iphone2",
    "invitor_name":"iphone2",
    "invitor_icon":"/icon/iphone2.png",
    "content":"hehe"
}

  • 响应的json 格式:

    成功 :

    {
    "sequence": "3",
    "type": "response",
    "flag": "true",
}

    失败 :

    {
    "sequence": "3",
    "type": "response",
    "flag": "false",
    "errorCode":"",
    "errorString":""
}
推送用户接受邀请

  • action : reinvitation

  • 请求的 key-Value

    key类型说明
    typeString请求：request
    sequenceString请求的序列号
    actionString请求的行为:reinvitation
    senderString发送者账号
    receiverString接收者的账号
    nameString接受邀请者的名字
    iconString接受邀请者的头像
    contentString邀请的文本内容

  • 请求的json 格式:

    {
    "sequence":"3",
    "type":"request",
    "action":"text",
    "sender":"iphone1",
    "receiver":"iphone2",
    "name":"iphone1",
    "icon","/icon/iphone1.png",
    "content":"hehe"
}

  • 响应的json 格式:

    成功 :

    {
    "sequence": "3",
    "type": "response",
    "flag": "true",
}

    失败 :

    {
    "sequence": "3",
    "type": "response",
    "flag": "false",
    "errorCode":"",
    "errorString":""
}
推送文本消息

  • action : text

  • 请求的 key-Value

    key类型说明
    typeString请求：request
    sequenceString请求的序列号
    actionString请求的行为:text
    senderString发送者账号
    receiverString接收者的账号
    contentString邀请的文本内容

  • 请求的json 格式:

    {
    "sequence":"3",
    "type":"request",
    "action":"text",
    "sender":"iphone1",
    "receiver":"iphone2",
    "content":"hehe"
}

  • 响应的json 格式:

    成功 :

    {
    "sequence": "3",
    "type": "response",
    "flag": "true",
}

    失败 :

    {
    "sequence": "3",
    "type": "response",
    "flag": "false",
    "errorCode":"",
    "errorString":""
}
推送用户名变更

  • action : nameChange

  • 请求的 key-Value

    key类型说明
    typeString请求：request
    sequenceString请求的序列号
    actionString请求的行为:nameChange
    senderString发送者账号
    receiverString接收者的账号
    nameString发送者变更后的名字

  • 请求的json 格式:

    {
    "sequence":"3",
    "type":"request",
    "action":"text",
    "sender":"iphone1",
    "receiver":"iphone2",
    "content":"hehe"
}

  • 响应的json 格式:

    成功 :

    {
    "sequence": "3",
    "type": "response",
    "flag": "true",
}

    失败 :

    {
    "sequence": "3",
    "type": "response",
    "flag": "false",
    "errorCode":"",
    "errorString":""
}

Android-模块化-面向接口编程，kotlin动态语言
m0_64604042的博客
12-16 1051
常见的模块化实现方式有两种 业务 Module 都放到同一个工程里。 每个业务 Module 都是一个独立的工程。 如图： 模块的划分 模块可分为多种类型，一般分为：三方的基础 SDK （网络请求，地图导航，推送等）；自己平台的通用功能（网络请求的能力封装、图片加载能力封装、权限设置、UI组件等）；业务模块的拆分（登录、交易、会员、硬件等）。 模块间通信 虽然功能已经按模块拆分，但是模块间通信也是多种形势，如果处理不好模块之间耦合严重维护成本增大。常见模块问通信有：直接依赖、事件或广播通信、路由通信、
安卓API文档
12-12
android 中文api是一款由官方推出的安卓开发参考资料，android api文档对安卓系统中的一些类库、方法进行介绍，非常适合想要学习android开发的朋友。
Android 开发API接口帮助文档 非常全 英文版
03-30
android API 接口离线说明文档.chm格式 带索引版 便于查询
Android开发接口帮助文档
03-29
android开发.chm格式接帮助文档 ，离线文档，方便查询各个类接口之间的继承关系以及使用说明。
Android官方API文档完整版（CHM离线参考）
最新发布
weixin_42124497的博客
11-01 1015
htmltable {th, td {th {pre {简介：Android官方API文档完整版是面向Android开发者的权威技术参考资料，涵盖所有Android版本的SDK接口、类库及开发工具。
Android 面向接口编程
热门推荐
极致的专注 无限的热情
07-04 1万+
关键词：Android、POP、面向接口编程 、面向过程、面向协议一、概述面向接口编程是面向对象编程的一种实现方式，它的核心思想是将抽象与实现分离，从组件的级别来设计代码，达到高内聚低耦合的目的。最简单的面向接口编程方法是，先定义底层接口模块，再定义高层实现模块。但是这样存在一个问题，就是当修改底层接口的时候，高层实现也需要跟着修改，这也违反了开闭原则。 在面相对象设计基本原则（SOLID）中，依
Android 接口文档
向着太阳迎着光
12-28 3422
前言每个项目进行研发之前，都会有很多的相对应的文档，当然比较重要的一个就是接口文档，当然接口文档版本也有很多，这边只是把自己写文档的一部分内容写个示例记录一下，方便以后自己查看。当然大家有很好的建议和意见可以关注和留言交流。一、设置描述设计描述，主要是介绍项目接口文档的业务及主要功能介绍，有交互方式、JSON数据交互格式、命名规则等做细分讲解。1）接口的调用方式： 移动端通过WebService和
精选资源
Android SDK 中文开发文档.pdf
05-10
Android SDK文档详细介绍了如何从零开始编写一个Android应用，包括设置开发环境、理解组件模型、使用API接口、调试技巧以及发布应用的步骤。 综上所述，《Android SDK 中文开发文档》是Android开发者的重要参考资料...
精选资源
Android 2.2 API中文文档合集
04-11
开发者可以在此文档中了解如何创建、启动和管理Activity，以及如何处理生命周期事件。 2. **Intent**: Intent是Android中用于通信的一种机制，可以用来启动新的Activity或者服务，传递数据。理解Intent的工作原理对...
精选资源
iData PDA RFID开发包 iData RFID开发资料 iData UHF模块接口文档 UHF模块开发指南
06-18
接口文档 UHF接口文档_v1.4 测试demo是否可用：将UHFDemo_v1.2.528.apk安装在PDA上，打开应用 测试功能是否可用。若可以正常使用，则可以参考demo/UHFDemo工程开发 应用，若功能不正常请和FAE沟通； 2. 导入库文件 ...
android api接口文档,API 接口文档
weixin_33435461的博客
05-28 1647
API 接口文档接口类说明本文档所有接口所涉及的相关类及说明如下：接口说明GsManagerSDK 功能接口类，用于调用个数相关功能GsConfigSDK 配置接口类，用于设置个数相关参数(注意：GsConfig 配置类需要在 SDK 初始化之前配置。)获取 GsManager类名com.getui.gs.sdk.GsManager接口public static GsManager getInst...
Android 接入文档
weixin_34228617的博客
12-25 134
2019独角兽企业重金招聘Python工程师标准>>> ...
360android应用接入文档
09-03
360官方提供的android移动应用接入文档。
Android官方API文档完整版
03-28
Android官方API文档完整版，从别处找到的。还算可以，全英文，需要一定的基础。
面向接口编程
03-09
一片很耐读的思想总结，反正我前前后后看了不下5遍，每次都会有新的收获
【Android】接口文档
chifu0892的博客
12-28 157
前言 每个项目进行研发之前，都会有很多的相对应的文档，当然比较重要的一个就是接口文档，当然接口文档版本也有很多，这边只是把自己写文档的一部分内容写个示例记录一下，方便以后自己查看。当然大家有很好的建议和意见可以关注和留言交流。 设置描述 设计描述，主要是介绍项目接口文档的业务及主要功能介绍，有...
Android-模块化-面向接口编程
m0_66640396的博客
04-28 466
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-M5paLqgu-1651119235346)(https://upload-images.jianshu.io/upload_images/24216715-25807c8cb942bb8e.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)] 模块的划分 模块可分为多种类型，一般分为：三方的基础 SDK （网络请求，地图导航，推送等）；自己平台的通用功能（网络请求的能
Android开发中文技术文档精华汇总
以上知识点仅是Android中文文档中可能包含的内容的冰山一角，实际上，由于Android系统的复杂性和开发的广泛性，相关的技术文档会更加详细和深入。开发者在学习过程中，需要根据具体的应用场景和需求，深入研究各个...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值