- 综合排序
- 最热优先
- 最新优先
- 来自专栏ThoughtWorks
细说API - 文档和前后端协作
在上一篇文章——《细说API - 重新认识RESTful》中介绍了如何理解和设计RESTful风格的API，现在我们来聊聊如何有效的呈现API文档，以及前后端协作的方式。 API 文档的缺乏给前后端协作带来困难，在缺乏专门工具的情况下，编写和维护文档是一件工作量巨大的事，人工处理也非常容易出错。 本文将会介绍三种方案来解决前后端协作的问题： 基于注释的 API 文档：这是一种通过代码中注释生成 API 文档的轻量级方案，它的好处是简单易用，基本与编程语言无关。 使用契约进行前后端协作：在团队内部，前后端协作本质上需要的不是一份 API 文档，而是一个可以供前后端共同遵守的契约。 围绕着 RAML 这一标准，构建出 API 协作的工具链，设计、构建、测试、文档、共享。 ?
2K30发布于 2019-03-08 - 来自专栏linux运维
协作场景：用AI加速TypeScript后端API开发
TypeScriptv5.2.2,PostgreSQLv15.3,Docker24.0.5,AI工具:Cursor(v0.42.0withClaude3.5Sonnet),GitHubCopilot.协作目标 :开发一个TypeScript的Express后端API，用于管理任务（CRUD操作），连接PostgreSQL，要求类型安全、性能稳定，部署到Docker。 15environment:-POSTGRES_DB=tasks-POSTGRES_USER=user-POSTGRES_PASSWORD=pass关键步骤初始化代码:用Cursor生成TypeScriptCRUD框架，10
41710编辑于 2025-08-31 - 来自专栏研发管理
API测试 | 3步走，通过协作实现API的高质量交付
在高频的迭代节奏中，这些协作上的问题会被不断放大，最终持续影响API的交付质量。想要解决这个问题，就必须从优化团队的协作结构着手。 协作失效：API质量下滑的重要原因自动化工具本应是质量的保障，但由于团队之间的工作流程并未真正打通，依然存在协作的断层。 3步构建API质量的协作体系协作层面的问题，并不会随着部署频率的增加而自动消失，反而会在一次次的快速迭代中被放大。 因此，若要从根本上提升API质量，就必须进行协作优化：1、构建统一的沟通语言这是打破信息壁垒的基础。开发、测试和运维团队需要在质量认知上达成共识。例如，一个测试用例应该包含哪些元素才算结构完整？ 在软件发布节奏不断加快、服务拆分日益精细的背景下，API已经成为保障系统稳定性和用户体验的关键环节。真正的挑战在于，能否让整个团队围绕着共同的质量目标，形成一套高效顺畅的协作机制。
26010编辑于 2025-10-13 - 来自专栏国产
用了这个API协作调试工具，忘记了postman
开始使用时感觉比较好的功能1、所有数据同步在云端，即使更换电脑，也可以通过浏览器使用（安装插件即可）；2、定义好API文档，就可以开始调试、Mock、自动化测试，非常方便；3、区分测试环境，因为我的项目多而杂 tos-cn-i-k3u1fbpfcp/3d02e8157a8944a4bd451693b8b5e059~tplv-k3u1fbpfcp-zoom-1.image" alt="" width="30%" />4、API 和之前工具的对比，以及对Apifox的建议之前使用过几款API调试工具，Postman等，它们给我的感觉是大同小异的，可以满足基本的接口调试工作，但是并没有我觉得很亮眼的功能，当然也有可能是我还没有接触到比较高级的操作
65220编辑于 2022-10-11 - 来自专栏个人路线
鸿蒙 API 9工程转换为API 10工程
运行环境 DevEco Studio：4.0Release OpenHarmony SDK API10 开发板：润和DAYU200 目前我们能够看到的是鸿蒙已经到API10，甚至今天在看OpenHarmony 官网的时候，4.1beta的分支都已经有了，也就是API11马上就出来了。 这个时候，我们最起码要将API 9工程转换为API 10工程。然后再慢慢的迁移到未来的11上。 接下来我们说一下如何迁移。 , "compatibleSdkVersion": 10, "targetSdkVersion": 10, "runtimeOS": "OpenHarmony "targetSdkVersion": 10, //指定OpenHarmony应用/服务目标版本。
3.7K10编辑于 2023-12-21 API 在线调试工具：助力高效开发与团队协作
Apifox 并非仅仅是另一个简单的调试器，它是一个集 API 文档管理、API 调试、API Mock 服务以及自动化测试于一体的综合性协作平台。 这意味着，开发者可以在一个统一的环境下完成 API 的设计、调试、模拟和自动化测试，极大地优化了工作流程，促进了前端、后端及测试团队之间的紧密协作。 简洁易用，协作无忧： Apifox 的界面设计简洁直观，操作逻辑清晰。其在线分享 API 文档的功能，省去了团队成员之间反复导出和传输文档的麻烦，让信息传递更加即时高效。 在线调试及协作平台，其设计理念充分考虑了国内开发者的实际需求，致力于简化 API 的测试和调试流程，从而有效提升开发效率与项目质量。 除了文中提及的功能，它还提供了更为完善的团队协作和项目管理特性，方便团队成员共享文档，协同推进项目。如果您正寻觅一款强大而易用的 API 调试工具，Apifox 绝对值得您深入体验。
69810编辑于 2025-09-23- 来自专栏研发管理
统一、测试、协作：3方向解析API Hub的高效API管理方案
版本混乱、信息滞后、协作割裂等问题逐渐成为企业数字化转型的障碍。传统零散的管理方式难以应对这种变化，迫切需要一个能够集中管理 API 全生命周期的平台。 SmartBear的API Hub（前身是SwaggerAPI） 它整合了设计、文档、测试和协作功能，为企业提供更高效和安全的 API 管理模式。 统一的API设计：从源头确保一致性API Hub 为 API 生命周期建立了“唯一真实来源”，让团队从设计阶段就能保持一致性。 开发人员无需改变日常习惯，就能让设计、代码与测试结果统一同步到 API Hub 中，实现更高效的跨团队协作。 API 管理早已超越了单纯的网关或监控，它需要覆盖完整生命周期的集中式平台，并能在协作与效率之间取得平衡。SmartBear 的 API Hub 正是这样一个面向未来的选择。
32510编辑于 2025-09-09 - 来自专栏鸿蒙开发笔记
如何更换OpenHarmony SDK API 10
OpenHarmony社区已经发布OpenHarmony SDK API 10 beta版本，有些 Sample案例 也有需要API10。 那么如何替换使用新的OpenHarmony SDK API 10呢？本文做个记录。 当前目录下已经有API9的SDK，我们需要新增下api10的SDK，创建一个名称为10的目录，如下：复制SDK压缩包version-Daily_Version-ohos-sdk-public-20230716 如图：解压后SDK的位置为：再打开DevEco Studio就可以看到看到新的API，如图：DD一下：欢迎大家关注工粽号<程序猿百晓生>，可以了解到以下知识点。 4、替换SDK遇到的问题4.1 The SDK management mode has changed在替换OpenHarmony SDK API10时，在DevEco Studio遇到了如下错误：The
71820编辑于 2025-06-19 API开发追踪工具：构建高效接口协作体系的核心引擎
在数字化浪潮下，API早已不只是开发细节，而是产品架构与交付效率的关键枢纽。特别是在前后端解耦、微服务架构广泛普及的今天，API的开发、联调、测试和版本管理已成为影响团队协作流畅度的重要因素。 这正是“API开发追踪工具”登场的时机——它们不仅承担接口任务管理职责，更像是一套帮助产品、研发、测试三方协调、共建、共管接口协作体系的中枢系统。 一套成熟的API开发追踪工具，应具备以下功能： 任务可视化管理 接口文档同步与变更控制 联调责任分配 权限分级与访问控制 多角色协同支持（产品/开发/测试） 这些能力的结合，使接口开发从“临时协作 二、接口协作体系中的“权限维度”与权限分级看板类似，API开发追踪同样面临“不同角色应看到不同内容、执行不同操作”的实际需求。 四、推荐API开发追踪工具盘点工具名称核心能力适用场景板栗看板轻量任务管理、本地化支持好、权限清晰国内团队协作首选，适合快速部署Jira敏捷管理强，支持插件拓展中大型技术团队多模块并行开发YApi接口文档
25320编辑于 2025-07-14- 来自专栏linux运维
协作场景：用AI快速开发一个Python Flask API
Ubuntu22.04,Python3.10.12,Flaskv2.3.2,SQLite3.36.0,Docker24.0.5,AI工具:Cursor(v0.42.0withClaude3.5Sonnet).协作目标 目标是用AI加速代码生成和调试，确保API高效、可靠，减少手动写SQL的时间。 /books.db:/app/books.db关键步骤初始化项目:用Cursor生成Flask和SQLite代码，10分钟搭建API框架。 错误处理:加try-catch和错误响应，API更健壮。Docker部署:用AI生成的Docker配置，30分钟完成部署。测试验证:用Postman压测，50并发下响应稳定在100ms。 代码质量:输入验证和错误处理让API更可靠，零SQL注入风险。部署顺畅:Docker配置开箱即用，部署到本地和云端零报错。
40710编辑于 2025-08-31 - 来自专栏科技记者
《高效R语言编程》9、10--高效协作和学习
高效协作的5条高级技巧： 保持统一的编码风格 仔细思考你的注释并随时更新 尽可能使用版本控制 信息化提交消息 不要害怕来自同事的反馈 编码风格 编码风格要前后一致，没有唯一，几个多数程序员都赞成的风格： install_github() #这个命令可以轻松安装github上的包，但是不能update 分支、分叉、更新、克隆 git是一个需要花费长时间学习的大型程序，掌握其高级功能的基础可使你成为一个较高效的协作者 git checkout -b test #相当于创建一个分支并转入分叉类似分支，但存放在别人机器上，通过git clone可以将该分叉克隆到本地，更易于协作。
1.4K20发布于 2021-07-27 - 来自专栏【云原生 • Prometheus】
【Spring源码】- 10 Spring AOP核心API
Spring AOP很多人不能很好的理解、使用，一方面是因为AOP涉及的概念可能比较抽象，不容易理解；另外一方面你对Spring AOP涉及到的一些基础API不熟悉。 下面我们就对Spring AOP中最核心的一些API，由底向上，由基础到高级方式一步步分析。 高级API 前面介绍的类、接口等都是Spring AOP中一些底层API，使用起来不太方便，感觉功能不太强大，不论是ProxyFactory还是ProxyFactoryBean创建织入切面的代理，每次只能硬编码一个具体的 总结 首先，对Spring AOP底层一些最基础、最核心的API的分析梳理，相信你会对Spring AOP底层实现逻辑有了一个更加深入的理解。 然后通过Spring AOP提供的高级API，理解了如何将IoC和AOP集成到一起实现强大功能，对Spring中AOP的整体实现思路也有了比较清晰的认识。
48221编辑于 2023-03-22 - 来自专栏java开发的那点事
10-RabbitMQ核心API-其他
Binding 绑定关系 Exchange和Exchange, Queue之间的连接关系 Binding中可以包含RouteKey或者参数 Queue 消息队列, 实际存储消息数据 Durability: 是否持久化, Durable: 是, Transient: 否 Auto Delete: 如果是yes, 代表当最后一个监听者被移除之后, 该Queue会被自动被删除 Message 消息, 服务器和应用程序之间传送的数据 本质上就是一段数据, 由Properties和Payload(body)构成 常用
28510编辑于 2022-10-06 - 来自专栏林德熙的博客
Windows 10 16251 添加的 api 工具
UWP 工具类库的控件库 HappyStudio.UwpToolsLibrary 1.0.4 给UWP工具类库的其他模块使用的依赖类库 WinRT XAML Toolkit for Windows 10
84810发布于 2018-09-18 - 来自专栏喔家ArchiSelf
API协议设计的10种技术
API协议的设计和实现需要考虑到安全性、可靠性和效率等因素，以确保数据的准确传输和系统的正常运行。 为了深入了解API的世界，这里对10个常见的API协议设计进行了梳理。 对于 API 而言，GraphQL 被视为一种新思路。GraphQL 既是一种用于 API 的查询语言也是一个满足你数据查询的运行时环境。 面向API 的事件驱动设计 "Event-Driven Architecture (EDA)" 指的是事件驱动架构，在API的领域中，表示为API而设计的事件驱动架构。 事件驱动架构强调系统中各个组件之间通过事件进行通信和协作。在这种架构中，组件可以是独立的服务、模块、或者整个系统。事件是系统中发生的事情，可能是状态变化、用户动作、外部触发等。 事件驱动的特性有助于微服务之间的通信和协作。一般地，API 网关可以充当事件的分发者，负责将事件发送到相应的订阅者。这有助于集中管理事件的流向和处理。
1.6K10编辑于 2024-01-29 Apipost vs Apifox：高效API协作的差异化功能解析
作为经历过多个企业级项目的API架构师，我深刻体会到工具选型对团队协作效率的致命影响。 最近深度使用APIPost和Apifox后，发现了几个令人惊喜的差异化功能，这些特性在实际开发中显著提升了我们的协作质量。 四、接口锁定：团队协作的保险栓在20人规模的跨职能团队中，我们曾因测试人员误改生产环境接口参数导致重大故障。
28800编辑于 2025-04-06- 来自专栏得物技术
得物API一站式协作平台探索与落地
示例：记人员为A， 下面所获取的业务线为{a, 80,b,60, c,10, d, 5}记人员为B，下面所获取的业务线为{a, 60,b,30, e,10}// 业务线aweight_a = (80+60 )/2 = 70// 业务线bweight_b = (60+30)/2 = 45// 业务线cweight_c = (10+0)/2 = 5// 业务线dweight_d = (5+0)/2 = 2.5 // 业务线eweight_e = (10+0)/2 = 5weight_a > weight_b > weight_c = weight_e > weight_d通过对项目数据的清洗，对YApi原有的项目进行了业务域的划分归属 图片通过对DTDD模式的探索和思考，最终完成了得物一站式文档协作平台的自主研发，Mooncake一站式文档协作平台的上线只是起点，绝不是终点，对于文档平台的展望如下图所示，通过文档协作平台的建设，推动业务发展 总结&思考本文简要给大家介绍了Mooncake作为得物一站式研发协作平台的演进过程。
1.8K110编辑于 2022-10-26 - 来自专栏JAVA并发编程
JAVA并发编程系列(10)Condition条件队列-并发协作者
另外synchronized的锁是通过JVM实现，而ReentrantLock是通过接口api实现。那Condition条件队列和对象的等待阻塞最大不同是什么？
41220编辑于 2024-09-23 - 来自专栏Harness合集
10｜Agent Harness 的未来：从代码助手到工程协作系统
下一步，它会从“代码助手”变成“工程协作系统”。趋势一：从单次问答到持续会话未来的Agent不会只回答一个问题，而是围绕一个任务持续工作。 趋势二：从单Agent到多Agent协作复杂工程任务天然需要分工。一个Agent负责理解架构，一个负责实现后端，一个负责前端，一个负责测试，一个负责安全Review。主Agent负责协调。 企业会怎么落地真正的企业级AgentHarness，可能长这样：展开代码语言：TXTAI代码解释模型层：多模型路由上下文层：代码图谱+文档RAG+工单数据工具层：MCP+内部API执行层：本地/容器/云端沙箱治理层 ：权限、审计、策略、审批质量层：测试、lint、CI、Review协作层：PR、IM、工单、文档它不再是单个工具，而是一套工程平台。 总结AgentHarness的未来，不是更花哨的聊天框，而是更完整的工程协作层。它会把模型、代码、文档、工具、权限、测试、CI、PR、工单连接起来，让AI从“回答问题”变成“参与流程”。
5900编辑于 2026-06-09 - 来自专栏程序手艺人
10 - AWS API 返回 Endpoint request time out
设备访问服务端的时候，返回Endpoint request time out，在stackoverflow看到有类似的问题 Amazon API gateway timeout 主要的原因 : 服务器端某个接口出现耗时的操作 Amazon API Gateway 限制和已知问题这个时间一般无法修改。 ? 主要还是检查服务器API中的耗时操作才解决该问题
1.8K10发布于 2019-05-07
腾讯云开发者
Copyright © 2013 - 2026 Tencent Cloud. All Rights Reserved. 腾讯云 版权所有
深圳市腾讯计算机系统有限公司 ICP备案/许可证号：粤B2-20090059 
粤公网安备44030502008569号
腾讯云计算（北京）有限责任公司 京ICP证150476号 | 京ICP备11018762号