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

REST API 设计最佳实践：如何构建、设计和使用 API ？

但是，我主要接触的是REST，这是一种基于资源的API和Web服务开发架构风格。在我的职业生涯中有很大一部分时间都参与了构建、设计和使用API 的项目。...但是，我也曾遇到过一些让 REST 蒙羞的 API 例子，错误使用 HTTP 状态码、纯文本响应、不一致的模式、插入端点中动词......不要嵌套资源 您可能已经注意到，REST API处理的是资源。检索资源列表或单个实例非常简单，但是，当处理相关资源时会发生什么呢？例如，假设我们想要检索特定作者（名为Cagan）的书籍列表。...最简单类型的分页就是按页码进行分页，它由page和page size确定。现在问题来了：如何将这样的功能融入REST API？ 我的答案是：使用查询字符串（querystring）。...使用专门针对REST API的网络框架 作为最后一个最佳实践，让我们讨论这个问题：如何在您的API中实际应用最佳实践？大多数时候，您希望建立一个快速的API，以便一些服务可以相互交互。

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

    用ASP.NET Core 2.1 建立规范的 REST API -- HATEOAS

    .jpg HATEOAS（Hypermedia as the engine of application state）是 REST 架构风格中最复杂的约束，也是构建成熟 REST 服务的核心。...HATEOAS的优点有: 具有可进化性并且能自我描述 超媒体(Hypermedia, 例如超链接)驱动如何消费和使用API, 它告诉客户端如何使用API, 如何与API交互, 例如: 如何删除资源, 更新资源...使用静态基类包装类  首先建立一个LinkResource，表示链接： ? 再建立一个抽象父类 LinkResourceBase： ? 它只有一个属性Links。...看之前的例子里面的Links链接，这些链接的格式并不是某个标准的格式，而是我自己创建的格式，消费者API并不知道如何处理这些Link，消费者API需要从API文档中了解如何解析Link，我需要在API文档里描述...这些其实就是之前的问题，我如何让API的消费者知道资源的表述应该是什么样的；还有我如何保证随着API的进化，API的消费者也会跟着进化？

    1.2K40

    用ASP.NET Core 2.0 建立规范的 REST API -- 预备知识

    它是一种架构的风格, 这种风格基于一套预定义的规则, 这些规则描述了网络资源是如何定义和寻址的. 一个实现了REST这些规则的服务就叫做RESTful的服务....REST的原则/约束 REST有6大原则/约束, 每一个原则都是对API有正面或负面影响的设计决定....项目建立好了, 结果如下: ? 然后我们看一下项目文件, 右键编辑MyRestful.Api: ? 这里, SDK属性表示了我们使用的是哪个SDK, 而目标框架是.NET Core 2.0....在Configure方法里, 配置应该遵循Add/Use的风格样式, 首先定义需要什么, 然后定义如何使用它....下图标明了这些过滤器在管道中是如何交互的： ? 过滤器可以作为属性标签使用，或者也可以在Startup类里面进行全局注册。

    2.1K00

    HTTP和HTTPS连接是如何建立的？

    HTTPS是在HTTP的基础上和ssl/tls证书结合起来的一种协议,保证了传输过程中的安全性,减少了被恶意劫持的可能.很好的解决了http的三个缺点（被监听、被篡改、被伪装）那么HTTP和HTTPS连接是如何建立的...简单的理解，HTTPS就是将HTTP中的传输内容进行了加密，然后通过可靠的连接，传输到对方的机器上。 HTTP和HTTPS连接是如何建立的？...三次握手保证了不会建立无效的连接，从而浪费资源。 4、四次握手(断开连接) 第一次：TCP客户端发送一个FIN，用来关闭客户到服务器的数据传送。...HTTPS · 在使用HTTPS是需要保证服务端配置正确了对应的安全证书 · 客户端发送请求到服务端 · 服务端返回公钥和证书到客户端 · 客户端接收后会验证证书的安全性,如果通过则会随机生成一个随机数...HTTPS是如何建立连接的，又是怎么进行加密的? 那HTTPS是如何建立连接的呢，怎么商量好加密密码的呢？

    2.2K31

    用ASP.NET Core 2.1 建立规范的 REST API -- 缓存和并发

    html 建立Richardson成熟度2级的POST、GET、PUT、PATCH、DELETE的RESTful API请看这里：https://www.cnblogs.com/cgzl/p/9047626...总的来说私有缓存会减少网络带宽的需求，同时会减少从缓存到API的请求。 而共享缓存并不会节省缓存到API的网络带宽，但是它会大幅减少到API的请求。...例如同时10000个客户端发出了同样请求到API，第一个到达的请求会来到API程序这里，而其它的同样请求只会来到缓存，这也意味着代码的执行量会大大减少，访问数据库的次数也会大大减少，等等。...这个比较适用于网络状态非常差的状态.  到目前也介绍了几个指令了, 其实大多数情况下使用max-age和public, private即可......最后客户1再更新（使用的是老的ETag）： ? 返回412。 本文比较短，一些关于缓存技术的内容并没有写，距离REST的主题有点远。

    83930

    TCP连接是如何建立和终止的？

    1表示已经确认 TCP连接是全双工的，每个方向都必须单独关闭 建立连接时如果超时了会发生什么事情？...即TCP的标识位R设置为1，客户端收到信息，知晓连接终止 类似场景：客户使用完自己的电脑，直接把电脑电源线拔了，这时服务器并不知道客户端已经消失，后续客户端再开机又会建立新的连接，这样导致服务器会存在许多半打开的连接...4次报文段交换，tcp本身的设计保证，这种场景仅建立了1个连接 其它协议族可能建立两条，比如OSI运输层 如果TCP两端同时关闭会怎么样？...原因：1：TCP主动关闭端发送的ACK如果丢失了，被动关闭端再次重发FIN，这时候的时间等待能够使得TCP主动关闭端发送最后的ACK不会丢失；2下次新的连接可能会复用同一个端口，如果由于网络延迟，老的数据才到...这种场景客户端可以再随便换一个端口即可，但是服务端的一般应用端口都是固定的，容易造成麻烦 如果多个请求同时到达服务端，服务端是如何处理的？

    2.1K10

    如何使用RESTler对云服务中的REST API进行模糊测试

    RESTler RESTler是目前第一款有状态的针对REST API的模糊测试工具，该工具可以通过云服务的REST API来对目标云服务进行自动化模糊测试，并查找目标服务中可能存在的安全漏洞以及其他威胁攻击面...如果目标云服务带有OpenAPI/Swagger规范，那么RESTler则会分析整个服务规范，然后通过其REST API来生成并执行完整的服务测试。...： dotnet nuget locals all --clear RESTler使用 RESTler能够以下列四种模式运行： Compile：从一个Swagger JSON或YAML规范生成一个RESTler...C:\RESTler\restler\Restler.exe compile --api_spec C:\restler-test\swagger.json Test：在已编译的RESTler语法中快速执行所有的...语法中，每个endpoints+methods都执行一次，并使用一组默认的checker来查看是否可以快速找到安全漏洞。

    7.1K10

    如何使用Spring和Java配置构建一个REST API

    使用@ExceptionHandler 7. 附加的Maven依赖项 8. 总结 1. 概览 本文展示了如何在Spring中配置REST——控制器和HTTP状态响应码、有效负载编排和内容协商的配置。...@RequestBody将方法的参数绑定到HTTP请求体，而@ResponseBody对响应和返回类型做同样的事情。 它们还确保使用正确的HTTP转换器对资源进行编排和反编排。...API的一部分，因此应该只在对应于REST的适当层中使用；例如，如果存在DAO/DAL层，则不应该直接使用上面的自定义异常。...api.version> 这些库用于将REST资源的表述转换为JSON或XML。...总结 本教程演示了如何使用Spring 4和Java配置来实现一个REST服务，讨论了HTTP响应码、基本内容协商和编排。

    3K30

    用ASP.NET Core 2.1 建立规范的 REST API -- 翻页排序过滤等

    html 建立Richardson成熟度2级的POST、GET、PUT、PATCH、DELETE的RESTful API请看这里：https://www.cnblogs.com/cgzl/p/9047626...我使用了这个参数类代替了之前的pageIndex和pageSize参数，因为ASP.NET Core足够智能，可以把这两个参数解析到这个类里面。 下面测试一下： ?...返回翻页的元数据 很显然只返回当前页的数据是不满足需求的，至少还需要返回总页数，总数等信息，还有可能需要返回前一页或者后一页的链接。但是如何把这些信息连同当页的数据一起返回给API消费者呢？...所以如果返回这样的数据就违反了REST的规则了（尽管本文代码的Richardson成熟度最多也就是2级），它违反了自我描述的约束（请参考本系列的预备知识文章），API消费者不知道如何通过application...排序的异常 还需要考虑到如果OrderBy里面的字段在映射表里面不存在的情况，所以我使用这个方法来进行判断： ?

    1.6K10

    用ASP.NET Core 2.0 建立规范的 REST API -- 预备知识 + 项目准备

    它是一种架构的风格, 这种风格基于一套预定义的规则, 这些规则描述了网络资源是如何定义和寻址的. 一个实现了REST这些规则的服务就叫做RESTful的服务....REST的原则/约束 REST有6大原则/约束, 每一个原则都是对API有正面或负面影响的设计决定....选择空模板, OK: 项目建立好了, 结果如下: 然后我们看一下项目文件, 右键编辑MyRestful.Api: 这里, SDK属性表示了我们使用的是哪个SDK, 而目标框架是.NET Core..., 然后定义如何使用它...., 就会返回以下信息: 我们也可以自定义返回的状态码信息: OK, 预备知识先介绍到这, 其它相关的知识在建立API的时候穿插着讲吧.

    3K72

    用ASP.NET Core 2.0 建立规范的 REST API -- DELETE, UPDATE, PATCH 和 Log

    html 建立Richardson成熟度2级的POST和 GET的RESTful API请看这里：https://www.cnblogs.com/cgzl/p/9047626.html 之前一篇文章介绍了...在REST API里，我们有时也会遇到这样的需求。我们暂时把这个方法叫做Upsert (Update + Insert) 。那么问题来了应该使用POST还是PUT呢？...annotations 数据注解，就是那种在属性上面的中括号样式的属性标签 如何数据注解无法满足要求，则可以使用自定义的验证方式 可以自定义数据注解 也可以让被验证类实现IValidatableObject...但是这两个类的大部分代码还是一样的，所以可以采取使用抽象父类的方法来去掉重复的代码，建立CityResource： ? 注意属性一定要使用virtual关键字，因为在子类里我们可能会重写属性。...Serilog支持把日志写入到各种的Sinks里，可以把sink看做媒介（文件，数据库等）。 我需要写入到文件，那么就安装： ?

    2.3K20

    用ASP.NET Core 2.0 建立规范的 REST API -- 预备知识 (2) + 准备项目

    然后当我们访问一个不存在的路由时, 就会返回以下信息: ? 我们也可以自定义返回的状态码信息: ? ? OK, 预备知识先介绍到这, 其它相关的知识在建立API的时候穿插着讲吧....可以看到, MyContext是OK的. 到这里, 就会出现一个问题, Controller的Action方法(也就是Web API吧)应该直接返回Domain Model吗?...用REST的术语来说, 我们把客户端请求服务器返回的对象叫做资源(Resources)....Interface 代表的是 "是什么样的", 而实现代表的是 "如何去实现". Interface一旦完成后是很少改变的....好的, 这次先写道这里, 项目已经做好了最基本的准备, 其余功能的扩展会随着后续文章进行. 下面应该快要切入REST的正题了.

    1.3K00
    点击加载更多

    相关资讯

    热门标签

    更多标签

    活动推荐

      运营活动

      活动名称
      广告关闭

      腾讯云开发者

      扫码关注腾讯云开发者

      扫码关注腾讯云开发者

      领取腾讯云代金券

      热门产品

      热门推荐

      更多推荐

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

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

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

      领券