首页 > 其他分享 >RESTful 接口设计规范 笔记

RESTful 接口设计规范 笔记

时间:2024-10-12 17:24:45浏览次数:8  
标签:http 跨域 eg 接口 网址 设计规范 RESTful 客户端

协议: API与用户的通信协议,http,https协议
域名: eg: http://example.com
版本: 如果接口有版本的迭代的话,可以在域名后面拼接版本标识,eg:http://example.com/v1
路径 又称终点 endpoint, 表示api的具体网址
在restful架构中,每个网址代表一种资源,所以网址中不能有动词,只使用名词且往往与数据库中的表格名对应。一般数据库中的表都是同种记录的集合,所以api中的名词也应该使用复数。

http动词,即接口的请求方法,eg: get,post,put(完整更新),patch(部分更新),DELETE, head(获取资源的元数据),options(获取信息,关于资源的那些属性是客户端可以改变的)。

过滤信息

状态码
客户端的每一次请求,服务器都必须给出回应,回应包括http状态码和数据两部分。


返回结果


错误处理


身份认证

跨域处理
可以在服务端设置cors允许客户端跨域资源请求,或客户端设置代理

标签:http,跨域,eg,接口,网址,设计规范,RESTful,客户端
From: https://www.cnblogs.com/jocelyn11/p/18460952

相关文章

  • C# 使用反射机制适配多个不同供应商提供的可统一接口化的行为(方法)
    1、定义一个接口(IMedicareControlFee)定义行为;定义一个适配器(IMedicareControlFeeAdapter)可应对多厂商(多态);usingSystem;usingSystem.Diagnostics;usingSystem.IO;usingJetSun.Infrastructure;usingJetSun.Infrastructure.Services;usingMicrosoft.Practices.Unity;usi......
  • fastapi请求豆包流式传输接口
    #main.pyfromfastapiimportFastAPI,BackgroundTasks,HTTPException,Bodyfromfastapi.responsesimportStreamingResponseimportasyncioimportjsonfromvolcenginesdkarkruntimeimportArkfromstarlette.middleware.corsimportCORSMiddlewareapp=Fa......
  • GenossGPT:开源AI模型的统一接口
    GenossGPT:开源AI的革新之路在人工智能快速发展的今天,各种强大的语言模型层出不穷。然而,不同模型间的接口差异给开发者带来了不小的挑战。为了解决这一问题,GenossGPT应运而生。这个开创性的开源项目旨在为各种AI语言模型提供一个统一的API接口,让开发者能够轻松地在应用中集成和切......
  • 拍立淘按图搜索商品列表接口系列,API接口开发
    拍立淘(Pailitao)是阿里巴巴旗下淘宝平台的一个功能,它允许用户通过上传图片来搜索相似的商品。然而,对于第三方开发者而言,直接访问淘宝的拍立淘接口进行API调用可能并不直接支持或需要特定的合作与授权。不过,我们可以探讨一种类似功能的实现方式,以及如何开发一个按图搜索商品列表......
  • Spring源码理解 类接口说明
    FactoryBean、BeanFactoryBeanFactoryBeanFactory是管理和生产Bean的,它是用于访问SpringBean容器的根接口。,定义了管理Bean的方法,获取Bean、包含Bean、是否单例Bean、获取Bean类型等。Spring根据他提供了很多实现,如DefaultListableBeanFactory、XmlBeanFactory、Applica......
  • 【STM32开发之寄存器版】(八)-定时器的编码器接口模式
    一、前言1.1编码器接口原理编码器模式主要用于检测旋转编码器的转动方向和转动速度。旋转编码器一般输出两路相位相差90度的脉冲信号(称为A相和B相),通过这两路信号,定时器可以判断编码器的旋转方向,并计数转动的脉冲数。1.2本次DEMO目标本次DEMO将使用STM32F103ZET6的PA6(......
  • 教你如何免费获取股票数据用python、JavaScript (Node.js)、JAVA等多种语言的实例代码
    ​近一两年来,股票量化分析逐渐受到广泛关注。而作为这一领域的初学者,首先需要面对的挑战就是如何获取全面且准确的股票数据。因为无论是实时交易数据、历史交易记录、财务数据还是基本面信息,这些数据都是我们进行量化分析时不可或缺的宝贵资源。我们的核心任务是从这些数据......
  • 京东 API 接口获取商品详情数据示例表格输出
    由于实际的API调用需要API密钥和访问权限,而且这些通常不公开分享,我将提供一个假设性的框架和示例,说明如何从京东API获取商品详情数据,并将其整理成表格形式。如果你已经有了京东开放平台的API访问权限,你可以根据以下步骤和示例代码进行调整,以实际获取数据。步骤一:获取京东API......
  • C#语言集成外国人永久居留证查验接口的方法
    随着全球化的深入和国际交往的日益频繁,越来越多的外国人选择在中国长期居住、工作,甚至定居。对于那些获得了中国永久居留资格的外国人而言,外国人永久居留证是他们在华生活、工作的重要身份证明。然而,作为一项涉及多方权益与安全的重要证件,外国人永久居留证的查验也同样至关......
  • 解锁京东店铺潜力:15大场景揭秘商品列表API接口
    随着电子商务的蓬勃发展,API接口成为连接商家与平台的重要桥梁。京东作为中国领先的电商平台,提供了丰富的API接口,帮助商家更高效地管理店铺和商品。主要用作于一下场景商品展示:在商家自己的网站或移动应用上展示京东店铺的商品列表,方便用户浏览和购买。库存管理:实时获取商......