Retrofit笔记 | 简析官方API文档(结合示例代码)

简介: Retrofit笔记 | 简析官方API文档(结合示例代码)
  • 其思想,类似于ListView、RecycleView的适配器(负责把布局和数据进行整合,然后渲染出来)
  • 创建一个Client交给它,它会帮我们去调用请求网络;默认使用OkHttpClient;

官方文档简阅

  • Retrofit会自动把返回数据转换成Call<List<Repo>><List<Repo>>位置类型的值;例如:
@GET("user/{id}")
    Call<User> getUserInfoWithPath(@Path("id") int user_id);
AI 代码解读

<List<Repo>>对应的位置类型就是User
所以上面这个Call方法 返回的就是一个User类型的实例
所以省去了我们用Gson解析的步骤:

private Api api;
---
User user = api.getUserInfoWithPath(1).execute().body();
AI 代码解读
  • Call<List<Repo>>随后的listRepos是方法名,

由开发者自定义,如以上实例代码中的getUserInfoWithPath()

  • 再往后是@Path("user")

这部分同注解("users/{user}/repos")中的{user}相对应,
指定的是通过什么字段去服务端Get

如示例代码中@GET("user/{id}")中的{id}就和@Path("id")相对应,
指定了方法getUserInfoWithPath()是通过id字段去服务端获取(GET)数据的,
例如User user = api.getUserInfoWithPath(1).execute().body();
聚焦getUserInfoWithPath(1)
就是到服务端查询到id字段是1User类数据,
查到之后就返回到客户端,
转化成一个id字段为1User类实例;
(也就是通过id字段去Get数据)

  • 再往后就是指定@Path("user")"user"数据类型了,

如以上String userint user_id

  • **定义完以上接口之后,

创建一个Retrofit类实例,
通过这个Retrofit实例创建一个方才定义的接口的代理实例

接口的代理实例编写语句类似于普通class的声明,
但是它事实上并不同于class声明那样子声明出一个实在的对象
而仅仅是一个接口代理对象(如下图的service)而已,
不是一个实实在在的接口对象
(我们知道接口一般是没有实例对象的)**


  • 接着通过方才创建出来的接口代理实例去调用Call<List<Repo>>随后的由开发者自定义的请求方法listRepos方法,

如以上实例代码中的getUserInfoWithPath()

即可:然后返回结果;

以上可以归结为三个步骤,示例代码如下:

//1. 定义对应 HTTP API的 Java接口
public interface Api {
    @GET("user/{id}")
    Call<User> getUserInfoWithPath(@Path("id") int user_id);
}

---
private Api api;

---
//2. 创建 Retrofit实例,通过该实例创建接口代理实例
      Retrofit retrofit = new Retrofit.Builder()
              .baseUrl("http://192.168.1.189:5000/")
              .addConverterFactory(GsonConverterFactory.create())
              .build();

      api = retrofit.create(Api.class);

---
//3. 通过接口代理实例调用自定义的请求方法,得到返回结果
User user = api.getUserInfoWithPath(1).execute().body();
AI 代码解读

其他API文档

  • 关于请求方法:
  • manipulation 操作,操控;
  • 把一个User实例转换成json形式进行提交(Post)
  • 表单(form)形式提交:
  • 多种类型数据提交:
  • 添加请求头部:
  • **Retrofit默认将HTTP bodies转化成OkHttpResponseBody

另外我们可以给Retrofit配置数据默认的转换框架
例如Gson(从这点看,Retrofit适配器):**





参考自 菜鸟窝

相关文章
小红书笔记详情 API 接口的开发、应用与收益
小红书(RED)作为国内领先的生活方式分享平台,汇聚了大量用户生成内容(UGC),尤其是“种草”笔记。小红书笔记详情API接口为开发者提供了获取笔记详细信息的强大工具,包括标题、内容、图片、点赞数等。通过注册开放平台账号、申请API权限并调用接口,开发者可以构建内容分析工具、笔记推荐系统、数据爬虫等应用,提升用户体验和运营效率,创造新的商业模式。本文详细介绍API的开发流程、应用场景及潜在收益,并附上Python代码示例。
167 61
小红书笔记详情 API 接口(小红书 API 系列)
小红书作为热门生活方式平台,拥有海量用户生成内容。通过其笔记详情接口,开发者可获取指定笔记的完整内容、作者信息及互动数据(点赞、评论、收藏数等),助力内容分析与市场调研。接口采用HTTP GET请求,需提供笔记ID,响应数据为JSON格式。注意小红书有严格反爬虫机制,建议使用代理IP并控制请求频率。
|
4月前
|
API
阿里云短信服务文档与实际API不符
阿里云短信服务文档与实际API不符
如何使用非结构化 API 高效处理文档
手动处理非结构化文档面临格式不一致、数据噪声多和信息检索困难等挑战,导致低效率和合规风险。Unstructured API 通过自动化文档处理,利用AI技术简化分类、归类和异常检测,节省时间和提高准确性。Supametas.AI 作为领先平台,支持多种文件类型(如文本、图片、视频),适用于各行各业,可与Salesforce、Zendesk等工具无缝集成,确保数据流动顺畅并提升工作效率。其强大的功能包括数据摄取、处理技术、检索增强生成、灵活性、可扩展性和集成能力,帮助企业和小公司高效处理大量非结构化数据,实现业务增长和优化工作流程。
52 4
小红书笔记详情 API 接口:获取、应用与收益全解析
小红书(RED)是国内领先的生活方式分享平台,汇聚大量用户生成内容(UGC),尤以“种草”笔记闻名。小红书笔记详情API接口为开发者提供了获取笔记详细信息的强大工具,包括标题、内容、图片、点赞数等。通过注册开放平台账号、申请API权限并调用接口,开发者可构建内容分析工具、笔记推荐系统、数据爬虫等应用,提升用户体验和运营效率,创造新的商业模式。本文将详细介绍该API的获取、应用及潜在收益,并附上代码示例。
138 13
通义灵码 API 开发文档自动生成场景DEMO
通义灵码API开发文档自动生成场景DEMO展示了通过自定义指令,大模型能快速根据类代码生成Markdown格式的API文档。文档详细描述API的入参、出参,并可生成测试代码等示例,帮助开发者快速创建美观的API文档。
|
1月前
|
小红书获取笔记详情API接口的开发、应用与收益。
小红书笔记详情API采用Python与Django框架开发,使用MySQL数据库存储数据。接口通过HTTP GET请求获取笔记详情,返回JSON格式数据,包含笔记内容、作者信息、图片链接等。该API应用于小红书APP内笔记展示和互动功能,并支持第三方平台的内容整合与数据分析,提升用户体验与活跃度,促进品牌合作推广,优化平台运营效率,为平台带来显著收益。
151 1
小红书笔记详情API接口的开发、应用与收益
小红书笔记详情API接口为开发者、企业和内容创作者提供了获取平台丰富资源的通道。通过该接口,用户可以提取笔记的详细信息(如标题、正文、标签等),并应用于市场调研、竞品分析、内容创作、电商推荐等多个领域。这不仅有助于提升品牌影响力和优化用户体验,还能挖掘商业机会,促进内容创新,增强用户互动与社群凝聚力。总之,小红书笔记详情API接口为企业和个人在社交媒体领域探索新增长点提供了重要工具。
180 0
淘系买家秀API接口系列,示例代码返回值说明
淘宝买家秀API接口是阿里巴巴旗下的淘宝平台提供的一种接口服务,允许淘宝商家或开发者通过编程方式获取并展示淘宝商品的买家秀信息,包括买家上传的图片、视频、评论等内容。以下是对淘宝买家秀API接口的详细介绍:

热门文章

最新文章

AI助理

你好,我是AI助理

可以解答问题、推荐解决方案等