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

Microsoft REST API指南

Microsoft REST API指南 摘要 Microsoft REST API指南作为一种设计原则，鼓励应用程序开发人员通过RESTful HTTP接口访问资源。...一致性的好处在于可以不断地积累合理的规范;一致性使团队拥有统一的代码、模式、文档风格和设计策略。 这些准则旨在达成如下目标： 为Microsoft技术平台所有API端点定义一致的实现和体验。...允许Service开发者利用其他Service的基础上来开发一致的REST API端点。 允许合作伙伴(例如,非Micosoft团队)使用这些准则来设计自己的 REST API。...符合Microsoft REST API准则的API应该支持PATCH。 7.4.3....我们建议团队与Microsoft REST API指导原则工作组协调，以帮助维护一致性。 Delta链接不能编码任何客户端 top 或 skip 值。 10.2.

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

    REST API设计指导——译自Microsoft REST API Guidelines（一）

    前言 前面我们说了，有章可循，有据可依，有正确的产品流程和规范，我们的工作才不至于产生混乱，团队的工作才能更有成效。...如果API的设计更规范更合理，在很大程度上能够提高联调的效率，降低沟通成本。那么什么是好的API设计？这里我们不得不提到REST API。...另外，REST API的书籍很多，但是完整完善实践丰富的设计指导并不多见，我们有幸看到了微软团队的作品——Microsoft REST API Guidelines，因此才有了此篇内容。...为什么用REST API? 1.前后端分离主要以API为界做接洽的，这样就会有很多的API，API的表现力更强，更加便于理解。...Microsoft REST API Guidelines目录 1 Abstract  摘要 2 Table of contents  目录表 3 Introduction  介绍 3.1 Recommended

    1.8K30

    REST API设计指导——译自Microsoft REST API Guidelines（三）

    前面我们说了，如果API的设计更规范更合理，在很大程度上能够提高联调的效率，降低沟通成本。那么什么是好的API设计？这里我们不得不提到REST API。...关于REST API的书籍很多，但是完整完善实践丰富的设计指导并不多见，我们有幸看到了微软团队的作品——Microsoft REST API Guidelines，因此才有了此篇内容。...5 Taxonomy 分类 As part of onboarding to Microsoft REST API Guidelines, services MUST comply with the taxonomy...Microsoft REST API 准则基本要求的一方面就是 服务的分类必须符合以下定义。...5.5 Long running API faults 长时间运行的API故障 For a Long Running API, it's possible for both the initial request

    1.7K30

    探索 .NET团队对API的设计流程

    我们先来看下.NET团队面临的有哪些挑战，您正在设计一套API库，每天有数百万的开发人员在使用这些库，它们在世界各地运行在重要的应用程序上面，您要对其进行改进并添加新功能或增强功能，而且不能破坏数百万个现有应用程序...在本文的其余部分中，我将按照我的理解来解释.NET API设计过程，这些是我根据对这一过程进行了几年的观察而得出的自己的解释，团队所做的大部分工作都是公开发布的，因此可以从他们如何组织.NET Core...API开始审查，在此会议上，.NET团队的核心专家汇聚一堂，评估方案并确保公共API适合目标框架，这是至关重要的一步，为了兼容性，设计中的错误或疏忽可能会持续很长时间，这意味着API决策需要彻底，团队也希望该...在API审核期间，会有人代表提案，并说明拟议设计的目标和原因，然后，团队将对其进行讨论，并确定提案是否需要进一步的工作，然后再批准，在被认为可以接受之前，可以在多次设计评审中提出一个API。...我建议开发人员应该很熟悉这个阶段，开发人员在git分支上完成了一些工作，一旦该工作完成并准备好考虑合并，就可以创建一个PR，一般可以直接合并到项目，但是出于质量考虑，其他开发人员通常会进行一个或多个代码审查，在Microsoft

    59910

    使用Magicodes.SwaggerUI快速配置SwaggerUI以及设置API分组

    Magicodes.SwaggerUI 快速配置和集成SwaggerUI 特点 通过配置文件简单配置即可完成SwaggerUI的API格式JSON生成和集成 支持API分组和隐藏 支持自定义页面和验证...github.com/xin-lai https://gitee.com/magicodes 更新日志 2019.10.21 【Nuget】Magicodes.SwaggerUI 2.0.1 【升级】单个文档不分组...，显示所有API 【梳理】梳理目录结构 【修复】修复本地开发环境运行时不加载文档注释的问题 【修改】自动移除GroupUrlPrefix的前后空格以及“/”前缀 【升级】在全局隐藏API的基础上，支持分组...API隐藏 【升级】API隐藏支持HTTP方法配置，默认“*” 2019.10.19 【升级】支持API分组，支持非侵入式配置，无需修改代码，仅通过配置即可完成API分组（见下面示例） 【重构】重构整体逻辑.../app1/" }, { "IsEnabled": "true", "Title": "APP2 API文档", "Version

    1.2K30

    RESTful API关键部分组成和构建web应用程序步骤

    RESTful API是一种基于HTTP协议的、符合REST原则的应用程序接口。...一个RESTful API由以下几个关键部分组成： 资源（Resources）：API的核心是资源，它可以是任何类型的数据（例如用户、产品、文章等），每个资源都有一个唯一的标识符（URI）。...实现路由：在应用程序中配置路由规则，将HTTP请求与相应的API方法关联起来。 测试和调试：使用工具（如Postman）来测试API，确保它能正确地响应请求并返回预期的结果。...文档和版本管理：编写API文档，以便其他开发人员了解如何使用API。同时，根据需要进行版本管理，以确保API的向后兼容性。...总结：通过遵循RESTful API的设计原则，可以使web应用程序的构建更加简单和灵活。同时，使用RESTful API还可以使应用程序的功能与UI分离，使其更易于维护和扩展。

    33810

    API 在线调试工具：助力高效开发与团队协作

    这意味着，开发者可以在一个统一的环境下完成 API 的设计、调试、模拟和自动化测试，极大地优化了工作流程，促进了前端、后端及测试团队之间的紧密协作。...对于预算有限的中小型团队而言，其高性价比不言而喻。对于大型企业，Apifox 也提供了私有化部署方案，充分满足安全和合规需求。 简洁易用，协作无忧： Apifox 的界面设计简洁直观，操作逻辑清晰。...其在线分享 API 文档的功能，省去了团队成员之间反复导出和传输文档的麻烦，让信息传递更加即时高效。 IDE 集成，效率倍增： 针对开发者常用的 IDE，Apifox 提供了插件支持。...拓展资源：API Hub — 开放共享的 API 平台Apifox 还构建了一个名为 API Hub 的开放 API 接口共享平台。...除了文中提及的功能，它还提供了更为完善的团队协作和项目管理特性，方便团队成员共享文档，协同推进项目。如果您正寻觅一款强大而易用的 API 调试工具，Apifox 绝对值得您深入体验。

    41910

    从API迭代中解放！GraphQL的优缺点与团队价值

    facebook推出的GraphQL，是一个特点非常鲜明的API查询语言。与SQL类似，GraphQL是一套规范，具体实现有很多框架。...本文会详细论述GraphQL的优缺点以及使用边界，以及对开发团队带来的价值。 1....2.2 开发价值——后端 对应后端开发同学而言，也有如下的价值： 减少针对性API设计 业务迭代时，修改方便 便捷文档（Code As Doc） 减少针对性API设计这点，主要体现在，比如针对『不同前端展示的字段不同...』这类需求，传统做法是，用如下不同的URL来区分 - api/app - api/miniapp 图片 而使用GraphQL，后端不需要改变/新增接口，前端可以通过自定义请求参数来控制返回的数据。...如果团队要使用GraphQL的话，也需要为其配备专门的鉴权、缓存等组件框架，目前这方面生态只能说勉强够用，在内部使用比较方便，如果对外商用的话，可能需要重新设计一套标准。 图片 4.

    4.1K341

    一个非常适合IT团队的在线API文档、技术文档工具

    之前单独写过一篇文章《介绍几款常用的在线 API 管理工具》，今天又发现个不错的工具，推荐给大家。 ShowDoc 每当接手一个别人开发好的模块或者项目，看着那些没有写注释的代码，文档呢？！文档呢？！...即使有文档，也是零零散散地放在团队不同人手里，到硬盘里搜一波，用 QQ 、邮箱直接丢，这种沟通当然可以，只是效率不高。...ShowDoc 是款适合 IT 团队的在线文档分享工具，可以让团队之间更高效的沟通。 ?...题图 from pixabay API 在线文档 APP、web 、Iot设备等前端与服务器常用 API 来进行交互. 方便快速地编写出美观的 API 文档，支持 MarkDown 语法....权限控制、团队协作 团队权限管理机制让团队良好地协同编写文档. 关键是：免费的开源的 ShowDoc 提供免费开源的版本. 你可以选择将 ShowDoc 部署到你的服务器.

    2.2K20

    【Android Gradle 插件】Gradle 依赖管理 ④ ( Android Gradle 插件中注册的依赖分组 | implementation | api | compileOnly )

    文章目录 一、Android Gradle 插件中注册的依赖分组 二、弃用的依赖分组 ( 现在仍然兼容 ) Android Plugin DSL Reference 参考文档 : Android Studio...参考文档 : https://developer.android.google.cn/studio/build/dependencies 二、弃用的依赖分组 ( 现在仍然兼容 ) ---- 添加构建依赖项...参考文档 : https://developer.android.google.cn/studio/build/dependencies compile 分组 : 编译 + 打包 ; 编译 : 将 依赖...加入到 classpath ; 打包 : 将 依赖 打包入 apk 安装文件中 ; apk 分组 : 只对 依赖 进行打包操作 , 该 依赖 不参与 编译 ; provided 分组 : 只对 依赖...进行编译操作 , 该 依赖 不参与 打包 ; 上述是已经弃用的 配置依赖项 的分组 :

    92310

    2025 API 开发协作新潮流，先进开发团队及企业如何选择？

    核心功能：Apipost 全方位领先 API 设计：精准定制，规范高效 先进的开发团队深知 API 设计规范对项目长期发展的重要性。...这一系列功能使 API 设计更加高效、规范，成为先进团队追求卓越的得力助手。 反观 Apifox，虽具备基本的 API 设计功能，但在满足个性化需求和细节处理上稍显逊色。...API 调试：无缝协同，快速定位 在 API 调试环节，先进团队追求的是高效与精准。Apipost 支持 HTTP、WebSocket、gRPC 等多种协议，满足各类复杂业务场景的调试需求。...越来越多的先进开发团队正在使用 Apipost 提升研发效率、保障 API 质量、促进团队协作，实现数字化转型与创新发展。...在 2025 年及未来，Apipost 将继续引领 API 开发协作新潮流，助力先进团队在激烈的市场竞争中脱颖而出，创造更多可能。

    22810
    点击加载更多

    相关资讯

    热门标签

    更多标签

    活动推荐

      运营活动

      活动名称
      广告关闭

      腾讯云开发者

      扫码关注腾讯云开发者

      扫码关注腾讯云开发者

      领取腾讯云代金券

      热门产品

      热门推荐

      更多推荐

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

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

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

      领券