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

用ASP.NET Core 2.0 建立规范的 REST API -- GET 和 POST

例如: api/getusers 就是不正确的. GET api/users 就是正确的 GET api/users/{userId}. 所以资源应该使用的是名词....如果是单个资源, 不应该这样 api/id/users, 而应该是 api/users/{userId}. (资源名是否复数还是根据个人习惯吧)....这里需要注意的是，针对集合的内容协商，如果集合是空的，也不应该返回404，因为这个Country资源是存在的，只不过它的内容是空的而已。 然后看一下GET 特定单个资源： ?...GET 父子关系的资源 这是一个典型的情景，一个国家包含多个城市，这就是父子关系。 首先看一下domain model： ? ? 这个应该很简单。...而GET方法本身比较简单，没什么说的，里面涉及的一些方法请自行编写。 看看运行结果： ? 如果找不到Country，则返回404： ? 下面GET 单个city： ?

2.1K10

十个书写Node.js REST API的最佳实践（下）

接 《十个书写Node.js REST API的最佳实践（上）》 5. 对你的Node.js REST API进行黑盒测试 测试你的REST API最好的方法之一就是把它们当成黑盒对待。...创建合适的API文档 你书写API，这样其他人就可以使用它们，并从中收益。给你的Node.js Rest API提供API文档是很重要的。...—— 这里可以了解更多 关于Falcor Falcor是推动Netflix UI的创新性数据平台。Falcor允许你在Node服务器端把你所有的后端数据模拟成单个的虚拟JSON对象。...在客户端上，你使用熟悉的JavaScript操作像get,set和call来和远程的JSON对象一起工作。如果你了解你的数据，那么你也会了解你的API。...——在这里了解跟多 令人惊讶的REST API，激发你的灵感 如果你正准备开始开发Node.js REST API或者给一个旧的项目开发新版本，我们在这里精心挑选了四个值得check out的真实案例

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

    RESTful 接口实现简明指南

    在前后端分离的 Web 应用架构中，前端专注于页面，同时与后端进行数据交互；而后端则专注于提供 API 接口。在这样的结构下，REST 是一个很流行的前后端交互形式的约定。...一、API 的 URL URL 用来定位资源，跟要进行的操作区分开，这就意味这 URL 不该有任何动词； 下面示例中的 get、create、search 等动词，都不应该出现在 REST 架构的后端接口路径中...；如果获取单个资源，传入 ID，比如 /api/users/123 表示获取单个用户的信息； 按照资源的逻辑层级，对 URL 进行嵌套，比如一个用户属于某个团队，而这个团队也是众多团队之一；那么获取这个用户的接口可能是这样...： GET /api/teams/123/members/234 表示获取 id 为 123 的小组下，id 为234 的成员信息 按照类似的规则，可以写出如下的接口 /api/teams （对应团队列表...三、分页、过滤 REST 风格的接口地址，表示的可能是单个资源，也可能是资源的集合；当我们需要访问资源集合时，设计良好的接口应当接受参数，允许只返回满足某些特定条件的资源列表。

    1.4K10

    RESTful 接口实现简明指南

    在前后端分离的 Web 应用架构中，前端专注于页面，同时与后端进行数据交互；而后端则专注于提供 API 接口。在这样的结构下，REST 是一个很流行的前后端交互形式的约定。...一、API 的 URL URL 用来定位资源，跟要进行的操作区分开，这就意味这 URL 不该有任何动词； 下面示例中的 get、create、search 等动词，都不应该出现在 REST 架构的后端接口路径中...；如果获取单个资源，传入 ID，比如 /api/users/123 表示获取单个用户的信息； 按照资源的逻辑层级，对 URL 进行嵌套，比如一个用户属于某个团队，而这个团队也是众多团队之一；那么获取这个用户的接口可能是这样...： GET /api/teams/123/members/234 表示获取 id 为 123 的小组下，id 为234 的成员信息 按照类似的规则，可以写出如下的接口 /api/teams （对应团队列表...三、分页、过滤 REST 风格的接口地址，表示的可能是单个资源，也可能是资源的集合；当我们需要访问资源集合时，设计良好的接口应当接受参数，允许只返回满足某些特定条件的资源列表。

    1.1K10

    安息吧 REST API，GraphQL 长存

    在客户端和服务器之间加入 GraphQL 层的考量有多种原因。其中之一，也许是最受欢迎的原因便是效率。客户端通常需要向服务器请求多个资源，而服务器会用单个资源进行响应。...因此，当客户端需要获取多个资源的数据时，需要对 REST API 进行多次往返，以将其所需的数据放在一起。 在 REST API 中，没有客户端请求语言。客户端无法控制服务器返回的数据。...例如，READ REST API 端点可能是 GET /ResouceName - 从该资源获取所有记录的列表； GET /ResourceName/ResourceID - 获取该 ID 标识的单条记录...这对客户端和服务器而言都是网络和内存资源的浪费。 REST API 的另一大问题是版本控制。如果你需要支持多个版本，那通常意味着需要新的端点。...它们当然不是 REST API 的所有问题，我也不想讨论 REST API 是什么。我主要讨论的是比较流行的基于资源的 HTTP 端点 API。

    3.4K30

    你真的知道你喜欢REST而不是RPC的原因吗？

    一般情况下如果向服务器发送该方法的多个相同请求的预期效果与对单个这样的请求的效果相同，则请求方法被认为是“幂等的”。 不一定是安全的。...就我目前所知，对于这种风格基本上没什么明确的约定和规则。 端点（或叫资源）包含要调用的操作的名称。 这种风格的API基本上只使用两个http动词，那就是你熟悉的GET和POST。...为了聚焦本文的主题，我们长话短说：使用REST API，你是将数据作为资源（resource），你通过HTTP协议使用正确的HTTP动词操作，注意，是正确的动词： 端点上包含你要操作的资源。...但某些情况下，设计一个REST API似乎比RPC更难一点，因为它给你定了一个框框，让你实现一致的API，让你必需依赖于资源，而不是操作。 这两个都需要去处理命名的一致性。...你甚至可以在单个API中混合使用这两种方法。虽然我并不想得出这样的结论，但根据上面的分析确实是这样。 具体环境，这是关键。

    1.4K60

    REST 入门介绍

    上面的文章建议大家认真的读一下，这里我们简要的介绍下REST 做入门介绍，理解整个 REST 能让我们在 ASP.NET Web API 的路上更顺畅。 REST是什么？...然后，你想看这一篇名为「REST 入门介绍」的文章，所以以你接下去点击这文章的标题连结，接去下阅读。...使用 WEB 标准 上述是最接近日常的范例，这些行为在 HTTP 规范中称之为 GET，也就是通过URL 来 GET 我想要的资源。...该操作传回新资源的URL 删除 整组资源 http://www.cnblogs.com/Products/1 Products/1是单个资源 取得 指定的资源的详细信息 更新 或新增指定的资源 新增 或附加一个新元素...在 RESTful 每个资源有自己独立的 URI， Client 从资源集合或单个资源开始进入，不管是资源集合或单个资源，我们都能与 HTTP 方法配合使用，例如，GET 下载，PUT 更新，POST

    1.6K80

    第 7 篇：文章详情的 API 接口

    目前为止，我们只实现了 GET 请求对应的 action——list 方法，因此路由器只为我们生成了一个 API，这个 API 返回文章资源列表。...GET 请求还可以用于获取单个资源，对应的 action 为 retrieve，因此，只要我们在视图集中实现 retrieve 方法的逻辑，就可以直接生成获取单篇文章资源的 API 接口。...get_object 方法通常情况下依据以下两点来筛选出单个资源对象： get_queryset 方法（或者 queryset 属性，get_queryset 方法返回的值优先）返回的资源列表对象。...lookup_field 属性指定的资源筛选字段（默认为 pk）。django-rest-framework 以该字段的值从 get_queryset 返回的资源列表中筛选出单个资源对象。...对应关系如下： HTTP 请求 对应 action 属性的值 GET list（资源列表）/ retrieve（单个资源） PUT update PATCH partial_update DELETE

    1.4K30

    Restful

    Restful设计风格在当前前后端分离的情况下使用的还是蛮多的，只是开发的时候可能更侧重于编码，对于一些基本的概念理论没有去更多的了解，本文就这部分内容做一个简单的梳理 什么是Rest REST是REpresentational...REST由四个接口约束定义：资源识别; 通过陈述来处理资源; 自我描述性的信息; 并且，超媒体作为应用程序状态的引擎。...这通过减少预先实现所需的功能数量来简化客户端 资源 在REST API的上下文中，当生成多个相同的请求与生成单个请求具有相同的效果时 然后该REST API称为幂等 如果您在设计API时遵循REST...原则，那么您将拥有用于GET，PUT，DELETE，HEAD，OPTIONS和TRACE HTTP方法的自动幂等REST API。...RESTFUL适用于移动互联网厂商作为业务接口的场景，实现第三方OTT调用移动网络资源的功能，动作类型为新增、变更、删除所调用资源 在目前主流的三种Web服务交互方案中，REST相比于SOAP（Simple

    77720

    什么是REST API ?

    什么是REST API ? 前言 作者：神的孩子都在歌唱 一. REST简介 REST 是 Internet 上计算机之间最常见的通信标准。 API 代表应用程序编程接口。...REST 基础知识 2.1 请求方式 RESTful API 将资源组织成一组唯一的 URI 或统一资源标识符。 URl 区分服务器上不同类型的资源。 如下图， 资源应按名词而非动词分组。...通过GET请求获取所有产品的 API 应该是/books，而不是/getAllBooks。 您可能听说过缩写词 CRUD，就是创建读取更新删除。 • POST 创建一个新资源。...• GET读取现有资源的数据。 • PUT 用于更新现有资源。 • DELETE 用于删除现有资源。 客户端通过 HTTP 向服务器请求资源。该请求具有非常特定的格式，如下图所示。...GET，PUT，DELETE是幂等。 1. 幂等： 调用多个请求将不会在服务器上新增数据，也就是当 API 是幂等的时，发出多个相同的请求与发出单个请求具有相同的效果 2.

    1.9K01

    花5分钟看这篇之前,你才发现你不懂RESTful

    URI包括URL和URN，在这里更多时候可能代指URL(统一资源定位符)。RESTful是面向资源的，每种资源可能由一个或多个URI对应，但一个URI只指向一种资源。...针对不同操作，具体的含义如下： GET /collection：从服务器查询资源的列表（数组） GET /collection/resource：从服务器查询单个资源 POST /collection：...在谈及GET,POST,PUT,DELETE的时候，就必须提一下接口的安全性和幂等性，其中安全性是指方法不会修改资源状态，即读的为安全的，写的操作为非安全的。...GET /dogs ：用来返回dog资源的列表。 GET /dogs/{dogid} ：用来查询此id的单个dog资源。...在本案例中，我们设计以下POST请求的API。 PUT /dogs/{dogid} ：用来更新此id的单个dog资源。

    1.7K41

    REST 已死：为什么你的 .NET API 应该迁移到 GraphQL

    查询（Queries）：获取数据（类似 REST 的 GET） • 单次查询可请求多个资源 • 字段可无限嵌套 • 始终保持幂等性（不改变数据） 2....变更（Mutations）：修改数据（类似 REST 的 POST/PUT/DELETE） • 单次请求可执行多个修改 • 返回更新后的数据 • 顺序执行（不同于查询） 3....订阅（Subscriptions）：实时更新 • 与服务器保持活动连接 • 数据变更时接收更新 • 适用于聊天应用、实时动态等 REST 与 GraphQL 对比 REST 方式（需多个端点） GET.../api/users/ GET /api/users//orders GET /api/users//preferences 需发起三次独立请求，且无论是否需要都会获取所有字段。...这与 REST 有本质区别——在 REST 中，每个端点通常映射到单个控制器操作；而在 GraphQL 中，可能需要数十个解析器协同工作以满足单个查询。

    57000

    Salesforce Integration 概览(五) Remote Call-In（远程操作 外部->salesforce）

    每个事务是针对单个Salesforce对象还是针对多个相关对象进行操作？ 消息的格式是什么（例如，通过HTTP的SOAP或REST，或两者）？ 消息大小是相对较小还是较大？...不支持对Salesforce的异步调用。 •REST API与SOAP API-REST将资源（实体/对象）公开为URI，并使用HTTP谓词定义对这些资源的CRUD操作。...使用restapi复合资源在一个API调用中进行一系列更新。 •REST复合资源使用这些REST API资源在单个API调用中执行多个操作。也可以使用一个调用的输出作为下一个调用的输入。...Apex REST services Suboptimal Apex类可以公开为映射到特定uri的REST资源，并使用针对它定义的HTTP谓词（例如POST或GET）。...您可以使用restapi复合资源在单个事务中执行多个更新。Apex REST服务与SOAP不同，它不需要客户机使用服务定义/约定（WSDL）并生成客户机存根。

    3.8K20

    RESTful杂记

    在网上找了许久的关于REST的资料，发现网上大部分都是说的比较片面，虽然有部分说出了本质，但也没有详细提出，所以在这里记录一下。...这段话比较绕口，总结一下，就是REST是一个为了进一步解耦client和server的架构风格。...可见性是指能单独的理解一个请求，可靠性是减轻了从局部故障中恢复的任务量， 可伸缩性是指为不必在多个请求之间保 存状态，从而允许服务器组件迅速释放资源 可缓存。 优势明显，不赘述。...了解了REST是什么东西后，我们才能设计出合适的API，以下是根据GITHUB API来总结的（基本参考自：https://cizixs.com/2016/12/12/restful-api-design-guide...XML， 应该在请求头部 Accept 中指定 以资源为中心 资源分为单个文档和集合，尽量使用复数来表示资源，单个资源通过添加 id 或者 name 等来表示 一个资源可以有多个不同的 URL 资源可以嵌套

    81410

    django-rest-framework框架学习

    前后端分离方式有许多好处，比如 1、可以前后端并行开发，提高开发效率 2、页面都在客户端进行渲染，提高了渲染速度，减小了服务器的压力 3、一套api提供给多个客户端使用，而且不限制客户端的类型（web，...app均可） 提到前后端分离必然会提到restful，目标这是最流行的接口规范，想要了解的可以去阮老师的博客看一下 越来越多的大型应用开始使用restful规范，restful强调一种无状态，资源的方式...在django中很著名的一个框架是django-rest-framework，帮我们减少了很多工作量，尤其在序列化与反序列化成我们需要的格式帮了我们省了很多事 在这里就记录一下个人的学习过程 django-rest-framework...api类，只需要继承rest_framework中generics中的某个类，重写我们需要的方法实现合适的逻辑即可 在urls.py中配置所需要的url 一组api的demo 创建一个model 在创建好的...在get方法中的self.request.GET.get(‘test’, None)是取出get方法传递的参数 lookup_field 应用于执行单个模型实例的对象查找的模型字段。

    1.9K10

    我是如何放弃 JSP，转向 REST 编程的

    这个时候，客户端就需要服务端提供的业务服务得是一个 API(应用程序访问接口)，客户端可以直接发起请求，这时候 REST API 就派上用场了。 什么是 REST 呢？...REST 是一种设计思想，它的核心是资源，可以理解成在 REST 的世界里，万物皆资源。...无论资源的形式如何变化，它要表达的内容其实是统一的，该资源存在还是不存在，单个信息还是多个信息，都有哪些属性，这就是资源的状态。...POST 查询个人资料 http://api.example.com/profile GET 修改个人资料 http://api.example.com/profile PUT 删除个人资料 http...://api.example.com/profile DELETE 简单讲，REST 就是 URL 定位资源，HTTP 方法操作资源。

    87010

    REST 架构-架构快速进阶教程

    简介 REST 是一种软件架构风格，它依赖于描述如何定义和访问资源的规则。很难想象没有RESTful API的现代互联网。在本文中，我们将深入探讨 REST 和相关 HTTP 概念。 2....另一方面，服务器处理并返回资源。它不会以任何方式影响用户界面。客户端和服务器都不需要了解其他职责。因此，它们可以独立进化。它允许在许多不同的客户端中使用单个API，例如Web浏览器，移动应用程序。...服务器的响应应提供有关是否应缓存以及缓存时间的信息。缓存更新的数据很少能提高性能并消除冗余的客户端-服务器交互。 分层系统。REST API 可以由多个层组成，例如业务逻辑、表示、数据访问。...HTTP 方法描述客户端要对资源执行的操作。有四种最常用的基本方法：获取、发布、放置和删除。让我们定义它们。 第一个，GET用于读取资源。服务器返回给定 URI 的资源。GET 方法不包含正文。...因此，它表明考虑到 REST 约束，API 的质量很好。 0级被称为痘沼泽。在这个层面上，API并没有使用HTTP协议的全部潜力，通常，它只使用POST和GET方法。因此，HTTP 协议仅用作传输层。

    30510

    restful api接口规范和服务调用的区别_rest接口规范

    虽然REST本身受Web技术的影响很深， 但是理论上REST架构风格并不是绑定在HTTP上，只不过目前HTTP是唯一与REST相关的实例。 1....URI URI 表示资源，资源一般对应服务器端领域模型中的实体类。 URI规范 不用大写； 用中杠-不用下杠_； 参数列表要encode； URI中的名词表示资源集合，使用复数形式。...资源集合 vs 单个资源 URI表示资源的两种方式：资源集合、单个资源。...Request HTTP方法 通过标准HTTP方法对资源CRUD： GET：查询 GET /zoos GET /zoos/1 GET /zoos/1/employees POST：创建单个资源。...POST一般向“资源集合”型uri发起 POST /animals //新增动物 POST /zoos/1/employees //为id为1的动物园雇佣员工 PUT：更新单个资源（全量），客户端提供完整的更新后的资源

    2.3K10
    点击加载更多

    相关资讯

    热门标签

    更多标签

    活动推荐

      运营活动

      活动名称
      广告关闭

      腾讯云开发者

      扫码关注腾讯云开发者

      扫码关注腾讯云开发者

      领取腾讯云代金券

      热门产品

      热门推荐

      更多推荐

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

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

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

      领券