文档建议反馈控制台
首页
学习
活动
专区
圈层
工具
MCP广场
文章/答案/技术大牛
发布

赏心悦目的RESTful API这样来设计！

，前端人员经常会询问下一步业务流程的接口定义在哪里，对接形式是什么样的 以上只是前后端人员通过接口交互的一小部分问题，这些问题就好比"牙痛"，不致命，但是在整个软件开发的生命周期内，天天"牙痛”是很要命的...名词 名词就是表示一个资源或者服务，如 /users，/teachers，这里看到我用名词复数的形式描述某一资源，至于用单数还是复数每个人都有自己的见解，我在这里推荐使用复数，因为在现实世界中，资源多数是以集合的形式存在的...sort=score_desc 按照学生分数降序进行排序 上述所有的方式我们都可以做到"望 URL 知意"，这就是好的设计 返回结果 RESTful API 的返回结果也是设计环节中重要的一环 响应数据格式...这种方法叫做 HATEOAS , 举个例子，列表页数据通常会有查看操作，这样我们在返回列表页的数据的时候同样返回如何操作查看具体数据详情的 API 接口： { "status": "-1", "result...欢迎交流你们在团队中是如何设计 RESTful API 的，遇到了哪些问题，是如何解决和规范的 - END -

1.9K10

如何设计好的RESTful API

，前端人员经常会询问下一步业务流程的接口定义在哪里，对接形式是什么样的 以上只是前后端人员通过接口交互的一小部分问题，这些问题就好比"牙痛"，不致命，但是在整个软件开发的生命周期内，天天"牙痛”是很要命的...名词 名词就是表示一个资源或者服务，如 /users，/teachers，这里看到我用名词复数的形式描述某一资源，至于用单数还是复数每个人都有自己的见解，我在这里推荐使用复数，因为在现实世界中，资源多数是以集合的形式存在的...sort=score_desc 按照学生分数降序进行排序 上述所有的方式我们都可以做到"望 URL 知意"，这就是好的设计 返回结果 RESTful API 的返回结果也是设计环节中重要的一环 响应数据格式...这种方法叫做 HATEOAS , 举个例子，列表页数据通常会有查看操作，这样我们在返回列表页的数据的时候同样返回如何操作查看具体数据详情的 API 接口： { "status": "-1",...欢迎交流你们在团队中是如何设计 RESTful API 的，遇到了哪些问题，是如何解决和规范的

2.2K20
    • 您找到你想要的搜索结果了吗？
    是的
    没有找到

    Fiddler实战

    2 中的框含义是：请求的起始时间，响应结束时间，等待时间，握手时间，路由时间，TCP/IP传输时间。 3 中的框含义是：http状态码统计。 4 中的含义是：返回各种类型数据大小统计以及拼图展现。...的含义是：只显示下面文本框指定的域名的数据流，如下所示： 如上我访问的是淘宝网，那么只会显示对a.tbcdn.cn和g.alicdn.cn的数据流；如上所示： 注意：文本框不会自动通过通配符匹配子域名...正在运行的应用进程和Fiddler在相同的主机时，Fiddler才能判断出是那个进程发出的哪个请求； 下拉框 Show only traffic from的列表中包含了系统中当前正在运行的所有进程，如下所示...fiddler来截取，自己自定义返回json数据，我们可以自定义返回的数据，如下所示，我是修改返回的内容如下所示： 当我们点击Run to Completion按钮后，在浏览器端可以响应数据，接着如下...响应类型和大小 通过如上选项，我们可以控制在Web sessions列表中显示那些类型的响应，并堵塞符合某些条件的响应。

    2.8K10

    REST 深度进阶

    使用 JSON 数据 别误解，这是我的习惯，不是 REST 的。 REST 并没有规定使用什么样的格式来传递数据，XML 也行，JSON 也行。但是在我的团队中，JSON 传递数据是一个硬性要求。...注意语义 在团队开发 API 时，有一个严格的要求，就是 API 名称需要有语义感。语义感这个词是我自己生造的，不是什么高大上的东西，就是要求写的 API 名称能使用正确的英文和次序，能够让人看得懂。...在我看来，所有的 API 都应该可以在不看注释和说明的情况下被调用方理解，从调用端点，到参数，和 JSON 的键。 这儿，我参考了国外的一些规则。规则也很简单： 用名词，别用动词。...保持响应的一致 一致性是好的 API 的优秀品质。开发中，我们应该在各种方面做到一致，包括命名、URI、请求、响应等。而在这里面，响应的一致性是我对团人的一个硬性要求。 API 是要让别人去调用的。...另一个影响性能的因素是 API 发送到调用端的数据量。要做到确保 API 只返回调用端需要的数据，而不是全部。如果可能，不要每次都返回完整的模型细节和关系。试一下，但要与响应中的返回模型保持一致。

    67810

    5个REST API安全准则

    必须确保传入的HTTP方法对于会话令牌/API密钥和相关资源集合，操作和记录都是有效的。 例如，如果您有一个RESTful API的库，不允许匿名用户删除书目录条目，但他们可以获得书目录条目。...（2）JSON编码 JSON编码器的一个关键问题是阻止在浏览器中执行任意JavaScript远程代码...或者，如果您在服务器上使用node.js。...使用正确的JSON序列化程序来正确编码用户提供的数据，以防止在浏览器上执行用户提供的输入，这一点至关重要。...这确保发送到浏览器的XML内容是可解析的，并且不包含XML注入。 4 - 加密 （1）传输中的数据 除非公共信息是完全只读的，否则应强制使用TLS，特别是在执行凭证更新、删除和任何事务操作时。...403“禁止”的真正含义未经授权，“我明白您的凭据，但很抱歉，你是不允许的！” 概要 在这篇文章中，介绍了5个RESTful API安全问题和如何解决这些问题的指南。

    5.1K10

    使用Ollama和Llama 2设置和运行本地LLM

    和英国电信公司工作，并担任顾问，帮助团队以更敏捷的方式工作。他写过一本关于 UI 设计的书，自那以后一直在撰写技术文章... 假设你的机器有足够的空间和内存，这样做的理由是什么？...除了不必支付他人服务器的运行成本外，你还可以在不担心安全问题的情况下运行对私有数据的查询。 为此，我使用的是 Ollama。这是“一个允许你在本地机器上运行开源大型语言模型 (LLM) 的工具”。...它们可以访问完整的开源模型列表，这些模型具有不同的专业化特点 —— 比如双语模型、紧凑型模型或代码生成模型。这起初是一个基于 Mac 的工具，但现在也可以在 Windows 上进行预览。...方便的控制台很好用，但我想使用可用的 API。Ollama 将自己设置为本地服务器，端口为 11434。我们可以通过一个快速的 curl 命令来检查 API 是否响应。...虽然开源 LLM 目前仍处于不断变化的状态，特别是在训练数据和偏见等问题上，但解决方案的成熟度显然在提高，给人们带来了对未来能力在考虑条件下的合理希望。

    1.1K20

    个人信用分接口完整开发指南：从加密传输到风险评估的实战应用

    一、"个人信用分"API接口在互联网金融风控、消费信贷审批、租赁场景信用评估、支付场景反欺诈、电商平台用户分层等众多场景中，精准的个人信用评分是进行风险决策的关键依据。"...本文将作为一份详细的开发文档，深入剖析此API的完整调用流程，详细解读其加密传输机制、请求响应数据结构和每一个核心字段的含义，帮助开发者利用信用大数据进行更深层次的风险分析与企业风控应用集成。...公共响应字段字段名含义说明code业务状态码0表示成功，其他值表示失败message状态描述对应状态码的文字说明transaction_id流水号本次请求的唯一标识，用于追踪和问题排查data加密数据...2001业务失败业务逻辑处理失败五、应用价值分析5.1 互联网金融风控场景在P2P借贷、消费金融、小额贷款等场景中，JRZQ0L85信用分API可以作为首道风控关卡：快速筛选：对于450分以下的申请用户直接拒绝...本文详细介绍了该API的完整接入流程，包括AES-128加密传输机制、请求响应数据结构、字段含义以及实际应用场景。

    20610

    个人司法涉诉（全量）API接口调用代码流程。接入方法以及应用场景

    本文将作为一份详细的开发文档，深入剖析此API，详细解读其返回的原始数据结构和每一个核心字段的含义，帮助开发者利用法律大数据进行更深层次的数据分析与企业风控应用集成。...: 所有请求的业务参数和响应的业务数据均经过AES-128-CBC加密。...请求参数: 核心业务参数为 name (姓名) 和 id_card (身份证号)，它们需要被封装在一个JSON对象中，然后进行加密，作为请求体中 data 字段的值。...处理响应 (响应体中的 'data' 字段也需要解密)if response.status_code == 200: response_data = response.json() # decrypted_result...案件类型 (Case Types)该API涵盖了以下主要案件类型，您可以在返回数据中找到对应的字段名来获取该类型的案件列表：字段名 案件类型 criminal

    81710

    （开发实战）从零接入企业风险报告API：接口调用、代码示例与核心数据全解析

    一、关于企业风险在企业尽职调查、金融机构风控 、供应链金融、投资决策支持等众多场景中，全面的企业风险分析数据是进行风险评估 6的关键依据。...本文将作为一份详细的开发文档，深入剖析天远API的这款核心产品，详细解读其返回的原始数据结构和每一个核心字段的含义，帮助开发者利用企业风险大数据进行更深层次的数据分析与企业风控 应用集成。...API的响应数据主体位于data字段中。...data.天眼风险: 综合风险等级和详细的风险事件列表。四、字段详解以下是各核心模块中关键字段的详细说明。1....建议开发者在接入时，充分利用返回数据中的风险等级 、风险评分以及 天眼风险 模块，构建多层次、自动化的风险预警机制。

    20210

    深度解析车辆出险查询API：Python接入方法、代码流程与应用场景

    本文将作为一份详细的开发文档，深入剖析此API，详细解读其返回的原始数据结构和每一个核心字段的含义，帮助开发者利用车辆出险查询API进行更深层次的数据分析与企业风控应用集成。...理解这些层级对于数据存储和前端展示至关重要。ckdlpc(车况排查-大类)：对车辆骨架、外观、发动机等核心部位的宏观评级。pzlsmx(碰撞明细)：包含维修总金额、总次数及具体的历史碰撞记录列表。...维修类型1:更换,2:维修,3:材料五、应用价值分析通过集成API的车辆出险查询接口，企业和开发者可以在以下场景中挖掘深度价值：二手车智能定价：结合ckdlpc（车况排查）和totalAmount（维修总金额...对于开发者而言，在对接过程中建议重点关注AES加密流程的准确性以及回调地址（return_url）的稳定性，以确保在大并发查询下数据的实时性和完整性。...利用API强大的数据整合能力，将帮助您的产品在竞争激烈的汽车数据服务市场中建立起坚实的信任壁垒。

    14810

    Python API 调用保姆级教程：从原理到第一次成功请求（附完整代码）

    PythonAPI调用保姆级教程：从原理到第一次成功请求（附完整代码）在当今的软件开发中，API（应用程序编程接口）几乎无处不在。...在写代码之前，你需要理解API交互的四个要素：Endpoint（端点）：你要去哪里取数据？通常是一个URL（例如https://api.4sapi.com/v1）。Method（方法）：你要做什么？...通常包含Authorization（你的APIKey）和Content-Type（数据格式）。Body（请求体）：具体内容是什么？（例如：你的Prompt提示词）。...三、代码实战：编写你的第一个API脚本新建一个文件main.py，并将以下代码复制进去。为了让你看懂每一行，我添加了详细的注释。...以下是三种最常见的错误代码及其含义：401Unauthorized含义：身份验证失败。解决：检查api_key是否填错，或者是否有多余的空格。

    40510

    一起学Elasticsearch系列-索引的批量操作

    它可以通过一次请求同时处理多个操作，提高数据的写入效率。 bulk API中，请求是通过一行一行的JSON数据进行定义的。每个操作（索引、删除、更新）都需要按照特定格式写在一行中。...示例： {操作描述符} {JSON数据} {操作描述符} {JSON数据} ... 注意以下几点： 请求数据中的每一行都必须是有效的JSON格式，且不能有多余的空格或换行符。...在一个bulk请求中，可以包含任意数量的操作。 bulk请求可以一次性执行多个操作，提高效率，但也会增加单个请求的复杂性和长度。 下面是bulk API的请求示例、响应示例以及一些常用参数的含义。...在 Elasticsearch 中，filter_path参数用于过滤返回的响应内容，可以用于减小 Elasticsearch 返回的数据量。...items.*.error 这个路径表示，在返回的响应中，匹配到所有存在 error 字段的 items。

    1K10

    开发者指南：学历信息查询API接口调用代码、接入方法及应用场景

    “学历信息查询”API，能够快速查询和验证高等教育学历信息的真实性，并追溯完整的学习经历。...作为数据服务的重要组成部分，本文将作为一份详细的开发文档，深入剖析此API (接口代码: IVYZ9A2B)，详细解读其返回的原始数据结构和每一个核心字段的含义，帮助开发者利用权威学历大数据进行更深层次的数据分析与企业风险管理应用集成...API (IVYZ9A2B) 在多个关键业务流程中具有重大的应用价值：人力资源与招聘在候选人筛选阶段，HR或用人单位可实时调用此API，验证候选人简历上填写的学历信息是否属实。...金融与信贷风控在银行、消费金融、小额贷款等场景中，申请人的学历水平是评估其还款能力和信用风险的参考维度之一。将此API集成到风控模型中，有助于更准确地描绘用户画像，优化信审决策。...六、总结本文详细介绍了天远API的学历信息查询API (IVYZ9A2B) 的接入方法、安全机制、请求与响应结构，并提供了完整的curl和Python调用代码示例。

    46110

    API：个人信用分API接口接入方法与加密调用流程全解析

    一、个人信用分API在金融信贷风险评估、互联网消费分期、在线租赁风控、招聘背景调查以及电子商务反欺诈等众多场景中，信用分评估是衡量用户风险等级与信用状况的关键依据。...个人信用分API 基于多头趋势分布、借贷行为、社交数据、流量特征、设备画像等多维度AI机器学习模型，输出综合信用评分（300–900分）。...本文将作为一份完整的开发文档，详细解读 个人信用分API 的调用流程、参数加密机制、数据结构与字段说明，协助开发者快速完成集成与业务应用。二、API接口调用示例1....()三、核心数据结构解析API响应结构包含三层：基础响应层：包括 code、message、transaction_id，用于标识调用状态与流水号。...code状态码0 表示成功，其它为错误message返回信息接口调用返回的状态描述transaction_id流水号本次调用的唯一标识data加密数据需解密后查看明文内容（3）业务数据字段字段名含义说明

    24410

    轻量级风控中间件实战：PHP集成天远信贷行为数据接口全流程

    一、关于API在搭建小额信贷审核后台、助贷机构CRM系统、以及流量分发与前置筛选等Web应用场景中，快速获取并解析用户的信用数据是提升业务转化率的核心。...本文档将作为PHP开发者的集成手册，详细演示如何使用原生PHP(或Laravel/ThinkPHP)对接此API，重点讲解AES-128-CBC在PHP中的加解密实现以及原始数据到前端可视化报表的映射逻辑...四、字段详解为了方便PHP开发者在Admin后台快速构建数据表格，以下选取了最常用于列表展示和详情页高亮的关键字段。...+严重逾期等级黑名单用户的典型特征五、应用价值分析在PHP驱动的Web生态中，集成天远API可以实现以下高价值场景：助贷机构CRM系统增强：在录入客户信息时，后台自动调用API。...流量分发前置筛选(TrafficFiltering)：在流量分发平台中，利用flag(是否查得)和ppcm_m3_overnum(逾期)进行前置过滤。

    22110

    实测好用的个人信用行为探针——金融借贷验证探针A API 全流程拆解与场景化应用

    解锁非银借贷数据的关键一环在消费金融、小额贷款、信用卡分期以及P2P平台风控升级等场景中，开发者常常面临一个挑战：央行征信虽可靠，但对非银机构的覆盖往往滞后，导致多头借贷或轻度逾期信号难以捕捉。...天远API的这一接口以其稳定性和数据深度脱颖而出，尤其适合中大型风控系统集成。本文旨在通过清晰的代码示例、结构解析和实际案例，指导你从参数加密到业务落地的全过程，让接入变得高效而直观。...核心数据结构解析：直击业务痛点解密后的响应是一个扁平JSON，聚焦于逾期画像和机构行为。...探查结论模块（决策起点）字段名示例值含义与业务提示result_code"1"A：逾期记录完整，可深入分析明细"4"U：数据稀疏，建议结合设备/运营商数据补全其他N：无记录，常見于年轻用户或低活跃群体逾期风险模块...数据清洗：用Pandas处理批量响应，映射逾期区间到数值分数（e.g.,61-90天=中风险）。扩展分析：与AA制卡数据融合，跑一个GBDT模型，特征重要性中逾期天数往往排前三。

    24810

    Python每日一练(21)-抓取异步数据

    基本原理 AJAX 的实现分为3步： 发送请求（通常是指HTTP请求） 解析响应（通常是指JSON格式的数据） 渲染页面（通常是指将JSON格式的数据显示在Web页面的某些元素上)。...通常在这个回调函数中利用服务端返回的数据渲染页面。 2.2 解析响应 这里的响应数据主要是指 JSON 格式的数据。...分析到这里，读者可以获得以下经验：如果数据没有在 Response 选项卡中，那么很可能是通过异步方式获取的数据，然后再利用 JavaScript 将数据显示在页面上。...从上面很明显可以看出获取数据的路由名字，在右侧的Preview 选项卡中显示了 data 返回的数据，很显然，这是 JSON 格式的数据，其实现在已经完成了任务，找到了异步访问的 URL，并且了解了返回的数据格式...如果我们可以批量获取多家企业的 id 后，就可以将 id 和 URL 形成一个完整的详情页对应详情数据的 AJAX 请求的 URL。

    3.7K20

    用Node.js快速集成学历核验服务：学历信息查询API 接入指南

    一、学历查询api的必要性在互联网招聘平台、消费金融风控引擎、在线教育认证系统、政务一网通办平台以及企业人力资源管理系统中，高效、可信的学历信息核验已成为数字化身份验证不可或缺的一环。...三、核心数据结构解析API 的响应设计兼顾安全性与结构化。...；education_background 是学历信息的核心容器，内含状态码 code（如 "9100"）、描述 msg 和学历数组 data；学历数组中的每项代表一个独立的学历阶段，字段扁平，无嵌套，...四、字段详解全局响应字段字段名含义说明err_code接口调用状态"200" 成功，其他为网络/鉴权错误err_msg错误描述如 "缺少Access-Id"data加密业务载荷需解密后使用业务数据字段（...六、总结本文完整演示了如何在 Node.js 环境中调用学历信息查询API（IVYZ9A2B），从请求加密、HTTP 调用到响应解密，提供了开箱即用的代码模板。

    27810
    点击加载更多

    相关资讯

    热门标签

    更多标签

    活动推荐

      运营活动

      活动名称
      广告关闭

      腾讯云开发者

      扫码关注腾讯云开发者

      扫码关注腾讯云开发者

      领取腾讯云代金券

      热门产品

      热门推荐

      更多推荐

      Copyright © 2013 - 2026 Tencent Cloud. All Rights Reserved. 腾讯云 版权所有

      深圳市腾讯计算机系统有限公司 ICP备案/许可证号：粤B2-20090059 粤公网安备44030502008569号

      腾讯云计算（北京）有限责任公司 京ICP证150476号 | 京ICP备11018762号

      领券