惯性聚合 高效追踪和阅读你感兴趣的博客、新闻、科技资讯
阅读原文 在惯性聚合中打开

推荐订阅源

Last Week in AI
Last Week in AI
有赞技术团队
有赞技术团队
钛媒体:引领未来商业与生活新知
钛媒体:引领未来商业与生活新知
人人都是产品经理
人人都是产品经理
博客园 - 司徒正美
博客园 - 聂微东
OSCHINA 社区最新新闻
OSCHINA 社区最新新闻
博客园 - 叶小钗
罗磊的独立博客
IT之家
IT之家
博客园 - 三生石上(FineUI控件)
V
Visual Studio Blog
T
Tailwind CSS Blog
大猫的无限游戏
大猫的无限游戏
Hugging Face - Blog
Hugging Face - Blog
H
Hackread – Cybersecurity News, Data Breaches, AI and More
N
Netflix TechBlog - Medium
MyScale Blog
MyScale Blog
J
Java Code Geeks
L
LangChain Blog
S
SegmentFault 最新的问题
奇客Solidot–传递最新科技情报
奇客Solidot–传递最新科技情报
Apple Machine Learning Research
Apple Machine Learning Research
G
Google Developers Blog

人人都是产品经理

为什么你的产品找不到差异化?90%的失败都卡在第一步上(下) – 人人都是产品经理, 3年从30万到1300万用户、获2200万美元融资,这个AI教育产品用“抽卡”破解了获客难题 – 人人都是产品经理, 园区招商系统怎么做才能真正帮到去化?我加了这一个功能,推广链接转发400次阅读过万 – 人人都是产品经理, AI大事件:OpenAI发完网络安全模型又搞药物研发,小鹏汽车要抓”DeepSeek时刻” – 人人都是产品经理, 电商不是卖货,是一场更残酷的产品经理实战 – 人人都是产品经理, 没想到,活动营销又回来了! – 人人都是产品经理, 为何All-in海外KOC:一场关于AI时代窗口期的豪赌 – 人人都是产品经理, 重新理解企业的内部协作 – 人人都是产品经理, 苹果的 AI 战略到底是什么? – 人人都是产品经理, 医疗智能体·第2讲——合规护城河:等保、PIPL与HIPAA的架构实战 – 人人都是产品经理, 向量知识库五步法:从“答非所问”到“精准回复” – 人人都是产品经理, 鸿蒙PC三方库构建总指挥HPKBUILD(sha)库为例 – 人人都是产品经理, 何时该用LLM?AI产品经理的LLM设计指南 – 人人都是产品经理, 医疗信息领域的需求方、决策方、准入方以及关注点(二) – 人人都是产品经理, 即梦涨价:一场被误读的「傲慢」 – 人人都是产品经理, 面试AI PM必答题:Hermes和OpenClaw的区别,如何讲清楚业务价值 – 人人都是产品经理, AI的下一张船票:世界模型——AI产品经理必须理解的技术拐点 – 人人都是产品经理, 小红书做GEO,怎么让AI信你?记住这 3 个重要信息 – 人人都是产品经理, 5 家印度 AI 初创公司,看看印度 AI 再做什么 – 人人都是产品经理, AI项目跨团队协作:产品技术业务如何不打架 – 人人都是产品经理, Agentic Workflow(智能体工作流):让AI从”答案生成器”变成”数字员工” – 人人都是产品经理, lycium_plusplus 项目全景解读:OpenHarmony 三方库构建的“大管家” – 人人都是产品经理, 从爆单救火到前置履约:两套预采策略,把生鲜大促履约效率拉满 – 人人都是产品经理, 什么时候该补货?我用一轮数据做了一个决定 – 人人都是产品经理, 从“机械兜底”到“动态分流”:AI客服重复进线治理的4大底层逻辑 – 人人都是产品经理, 抖音拼效率,红书拼洞察 – 人人都是产品经理, 全民狂欢与退潮——为什么龙虾这波热潮冷却得如此之快? – 人人都是产品经理, Stripe押注!MPP重塑全球支付 – 人人都是产品经理, 小红书GEO:AI引用你的内容,不是因为你对,而是因为你看起来可信 – 人人都是产品经理, 前百度副总裁押注办公Agent,日韩付费爆发,Manus迎来强劲对手 – 人人都是产品经理,
一文搞懂API接口那些事儿
思睿 · 2024-06-29 · via 人人都是产品经理

在产品设计和开发中,灵活使用现有的API接口能更好完成当前设计。这篇文章,我们就通过案例来了解下API接口的相关知识。

一、接口:数字世界的握手

想象一下,你走进一家咖啡馆,你对咖啡师说:“我要一杯拿铁。”咖啡师接收到你的指令,用他的专业技能制作出一杯香浓的拿铁给你。在这个过程里,你不需要知道咖啡机怎么使用,也不需要了解咖啡豆的烘焙工艺,更不需要知道咖啡怎么做。

你和咖啡师之间的交流,就像你和咖啡师之间有个“接口”——它定义了你如何请求服务,以及服务如何响应你。

在软件的世界里,接口就像是一个规则手册,告诉不同的程序或者服务,“嘿,如果你想和我聊天,这是你能对我说的话,以及我可能会怎么回答你。”

这些规则让软件组件能够相互沟通,而不需要了解对方内部的复杂细节。

再具体一点,假设程序员A开发了软件A,程序员B正在研发软件B。

有一天,程序员B想要调用软件A的部分功能,但是他又不想从头看一遍软件A的代码,怎么办呢?

程序员A想了一个好主意:我把软件A里你需要的功能打包好,写成函数;你把这个函数放在软件B里,就能直接用我的功能啦~
其中,API 就是程序员A说的那个函数。

二、接口的组成:软件的对话指南

知道接口的作用,程序员之间如何看懂并调用对方的接口的呢,我们将接口的组成简化为五个关键部分:请求方法、接口地址、请求参数、返回参数、返回结果示例。

想象一下,还是刚才点咖啡的场景。

1. 请求方法 (Request Method)

相当于你选择的点咖啡方式。接口中有Get 和Post 两种方式。

Get就像你你在咖啡馆门口,手里拿着一张咖啡馆的菜单,你知道菜单上咖啡的价格、种类(只是获取信息)。GET请求,是在请求服务器提供一些特定的信息,而不会改变服务器上的任何数据。在技术上,GET请求通常用于检索数据,且可以被缓存。

而Post是你直接走进咖啡馆,看到菜单之后,跟服务员点单“我要一杯大杯的热拿铁,少糖”(不仅仅是在获取信息,而是在发起一个动作,即下订单)。服务员会记录订单、信息、排号。这相当于POST请求,它用于向服务器发送数据,可能会创建一个新的资源或更新现有的资源。POST请求通常不被缓存,因为它们代表了一次新的操作。

2. 接口地址 (Endpoint)

接口地址就像是咖啡馆的位置,它是你与咖啡师交互的具体地点。你必须知道这个地址,才能去点咖啡、去咖啡。在接口中,这就是服务器上的具体资源位置,比如https://api.example.com/users。

3. 请求参数 (Request Parameters)

当站在咖啡馆的柜台前,可能会说:“我要一杯大杯的热拿铁,少糖。”

这里的“大杯”、“热”和“少糖”就是请求参数,它们告诉咖啡师你具体想要什么样的咖啡。

在API中,请求参数是你传递给服务器的具体信息,比如用户ID、产品类型等,以便服务器能准确地响应你的需求。

4. 返回参数 (Response Parameters)

当咖啡师听到你的要求后,他会开始制作咖啡,并在完成后告诉你:“您的大杯热拿铁,少糖,一共9.9元。”

这里,“大杯热拿铁”、“少糖”和“9.9元”就是返回参数,它们是咖啡师基于你的请求给出的反馈。

在API中,返回参数是服务器根据你的请求生成的信息,比如订单状态、结果代码、200、404等。

5. 返回结果示例 (Response Example)

如果把整个过程完整地描述出来,就相当于API的返回结果示例。

例如,当你在咖啡馆下单后,你可能会收到一个收据,上面写着:“订单号#123456,一杯大杯热拿铁(少糖),总价9.9,预计10分钟后完成。”

这个收据就是一个返回结果示例,在API中,这通常是一个JSON或XML格式的数据包,详细说明了你的请求是如何被处理的,以及结果是什么。

三、接口文档示例

【API示例】获取明天北京的天气预报。

【请求方法】GET

【接口地址】https://api.weatherprovider.com/v1/forecast

【请求参数】

【返回参数】

【返回结果示例】

懂接口对产品经理来说有什么用呢?

(1)前后端的协作,通过接口实现,后端写接口,前端去调用,这个过程出现问题,比如页面没有数据,点击功能按钮为什么没有反应?等等这些问题,降低沟通成本,更理解,也更兼容。

(2)当你手里有一份接口文档,能理解每个接口解决了什么问题;在产品设计的时候,请求参数的清晰定义,响应参数返回的字段正确显示;也是产品设计中需要考虑的一部分。

(3)第三方API对接时,通过返回参数获取关键指标,数据是系统的基础,比如像G端业务会涉及到跟其他系统的对接,对接给到的接口文档能看懂,提取关键信息,也许其中的某些字段就成为需求的一部分。

希望这个关于接口的解释,能对你有用呀,手里有粮,心中不慌。

欢迎评论区一起交流,一起成长。

本文由 @思睿 原创发布于人人都是产品经理。未经作者许可,禁止转载。

题图来自Unsplash,基于CC0协议。

该文观点仅代表作者本人,人人都是产品经理平台仅提供信息存储空间服务。