首页 > 其他分享 >设计优秀的API接口如何实现?

设计优秀的API接口如何实现?

时间:2024-06-14 17:37:08浏览次数:18  
标签:baidu 优秀 接口 域名 api com id API

电商大数据是指通过对电子商务平台产生的海量数据进行收集、存储、处理和分析,以揭示其中蕴藏的商业价值和规律性,并据此进行决策和优化的一项技术和方法体系。

在设计接口时,有很多因素要考虑,如接口的业务定位,接口的安全性,接口的可扩展性、接口的稳定性、接口的跨域性、接口的协议规则、接口的路径规则、接口单一原则、接口过滤和接口组合等诸多因素,本篇文章将简要分析这些因素。【电商数据API接口接入

1

规范性建议

1、职责原则

在设计接口时,必须明确接口的职责,即接口类型,接口应解决什么业务问题等。

2、单一性原则

在明确接口职责的条件下,尽量做到接口单一,即一个接口只做一件事,而非两件以上。很多非资深接口设计者,在设计接口时,总认为接口所做的事越多,越牛叉,这是非常严重的错误认识。

3、协议规范

在设计接口时,应明确接口协议,是采用HTTP协议,HTTPS协议还是FTP协议,要根据具体情况来定。

(1) FTP协议(File Transfer Protocol,简称FTP),是一套标准的文件传输协议,用于传输文件,如.txt,.csv等,一般文件传输,采用FTP协议。

(2) HTTP协议,适用一般对安全性要求比较低或没要求的业务情景。

(3) HTTPS=HTTP+SSL,适用于对安全性要求较高的业务情景。

4、路径规则

由于api获取的是一种资源,所以网址中尽量为名词,而非动词

/api/v1.0/Pruduct/2019

/api/v1.0/Users/2019

5、http请求方式

接口基本访问协议:get(获取),post(新增),put(修改)和delete(删除)

get /users:列出所有用户

get /users/id:根据id获取用户

post /user:新增用户

put /user/id:根据用户id更新用户

delete /user/id:根据用户id删除用户

6、域名

一般地,域名分为主域名和专有域名,主域名适合api长期不变或变化较少的业务,专有域名是解决具体的专有业务的

以百度举例:

(1) 主域名:www.baidu.com

(2) 产品服务类

百度文库:https://wenku.baidu.com/

百度知道:https://zhidao.baidu.com/

百度资讯:https://zhidao.baidu.com/

(3) 市场活动类

百度公益:http://gongyi.baidu.com

百度logo:http://logo.baidu.com/

百度世界:https://baiduworld.baidu.com

7、跨域考虑

在明确域名的情况下,一定要考虑接口是否跨域,以及跨域应采用的技术手段等

8、api版本

对于接口的url,应加版本号http://api.demo.com/v{d}/,如 ,其中d表示版本号,如v1.0,v2.0

例子:获取产品号为2019,版本号为v1.0的版本号的产品信息

/api/v1.0/Pruducts/2019

9、适度过滤信息

当记录数比较多时(如 SELECT * FROM TBName),因适当添加一些条件对数据进行过滤,如TOP,分页,分组,排序和WHERE条件等

下面是一些常见的参数。

?limit=100:返回100条数据

?offset=101:从第101条数据开始返回

?page=10:指第10页

per_page=100:每页100条数据

?sortby=name:排序字段

?order=desc:降序

?group=groupName:分组

?producy_type=1:筛选条件

10、返回数据格式

返回数据格式,一般包括三个字段:

(1) 失败情况(状态码、错误码和错误描述)

 (2) 成功情况(标识id,数据对象,状态码)

11、安全性原则

接口暴露的考虑,接口并发量的考虑,接口防攻击的考虑,接口跨域的考虑等。

12、可扩展性原则

在设计接口时,充分考虑接口的可扩展性。

13、定义api界限

任何api,从权限上,可归结为匿名api和非匿名api,前者不需要验证,后者需要验证。

14、定义api返回码

在api设计时,要定好api返回码,如:

1 --授权过期

404--未找到资源

500--内部服务器错误

600--账号被锁

 

标签:baidu,优秀,接口,域名,api,com,id,API
From: https://www.cnblogs.com/xdedm-Lisa/p/18248308

相关文章

  • 实时api接入指南|1688商品详情实时数据接口(1688.item_get)图片、库存、规格、销量等数
    接入1688商品详情实时数据接口(1688.item_get),涉及到图片、库存、规格、销量等重要信息的获取,这些数据对于电商平台来说至关重要,可用于商品展示、分析市场趋势、优化库存管理等。下面将详细讨论如何接入此API接口,并有效利用返回的数据:注册与创建应用账号注册:需要进行账号注册......
  • 进程还在,JSF接口不干活了,这你敢信?
    1、问题背景:应用在配合R2m升级redis版本的过程中,上游反馈调用接口报错,RpcException:[Bizthreadpoolofproviderhasbeenexhausted],通过监控系统和日志系统定位到现象只出现在一两个节点,并持续出现。第一时间通过JSF将有问题的节点下线,保留现场,业务恢复。报错日志如下:24-03-......
  • 界面组件DevExpress Office File API - 如何用OpenAI增强文档可访问性(二)
    DevExpressOfficeFileAPI是一个专为C#,VB.NET和ASP.NET等开发人员提供的非可视化.NET库。有了这个库,不用安装MicrosoftOffice,就可以完全自动处理Excel、Word等文档。开发人员使用一个非常易于操作的API就可以生成XLS,XLSx,DOC,DOCx,RTF,CSV和SnapReport等企业级文......
  • 华为OD API集群负载统计
    题目描述:某个产品的RESTfulAPI集合部署在服务器集群的多个节点上,近期对客户端访问日志进行了采集,需要统计各个API的访问频次,根据热点信息在服务器节点之间做负载均衡,现在需要实现热点信息统计查询功能。RESTfulAPI的由多个层级构成,层级之间使用/连接,如/A/B/C/D这个地址......
  • FastAPI快速入门1 Hello World
    1HelloWorld1.1HelloWorldch01/main.pyfromfastapiimportFastAPI,APIRouter#1app=FastAPI(title="RecipeAPI",openapi_url="/openapi.json")#2api_router=APIRouter()#3@api_router.get("/",status_code......
  • ArcGIS JSAPI 高级教程 - ArcGIS Maps SDK for JavaScript - 添加自定义(GLSL)数据
    ArcGISJSAPI高级教程-ArcGISMapsSDKforJavaScript-添加自定义(GLSL)数据核心代码完整代码在线示例ArcGISMapsSDKforJavaScript从4.29开始增加RenderNode类,可以添加数据以及操作FBO(ManagedFBO);通过操作FBO,可以通过后处理实现很多效果,官方提供了几......
  • select()API
    编写TCP客户端和服务端程序,客户端通过多路IO复用同时处理标准输入(文件描述符为0)和套接字。当输入为quit时程序结束;当通过套接字收到对方消息时把收到的消息再次转发给对方,服务器端需通过select()监控listenfd和accept()后建立的新的套接字newfd,可只写select()相关的主要代码。  ......
  • 讯飞有一个可以根据描述文本自动生成PPT的AI接口,有趣
    文档:https://www.xfyun.cn/doc/spark/PPTGeneration.html 价格方面提供了免费1000点的额度,生成一次是10点,正好100次,如果要购买的话最低要购买1344元的,没有按量付费的模式,个人小开发者可买不起。 让我们跑起来玩玩,官方提供了python的sdk,下载到本地: 不想下载sdk的,我......
  • FastAPI-9 服务层
    9服务层本章阐述了服务层,即中间层。9.1定义服务服务层是网站的核心,它接收来自多个来源的请求,访问作为网站DNA的数据,并返回响应。常见的服务模式包括以下组合:创建/检索/更改(部分或全部)/删除一件事/多件事在RESTful路由器层,名词是资源。在本书中,我们的资源最初将包括隐......
  • 6.13API接口服务类漏洞探针
    ip地址解析:www.x.x.x.com,对应网站目录为d:/wwwroot/xiaodi/而127.x.x.x,对应网站目录为d:/wwwroot/,可能存在网站备份文件zip,所以ip网址端口都的扫描;协议端弱口令爆破:超级弱口令检查工具;端口服务安全问题(用于无思路时)思路:利用探针对端口探测后,对口令安全、Web漏洞、中间......