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

我所理解的RESTful Web API

300~399：重定向状态码，代表需要客户端采取进一步的操作才能完成请求。 400~499：客户端错误状态码，代表了客户端看起来可能发生了错误，妨碍了服务器的处理。...500~599：服务器错误状态码，代表了服务器在处理请求的过程中有错误或者异常状态发生，也有可能是服务器意识到以当前的软硬件资源无法完成对请求的处理。...请求报文和响应报头采用纯文本编码，由一行行简单的字符串组成。一个完整的HTTP报文由如下三个部分构成。...上述这个请求报文不具有主体，所以起始行之外的所有内容均为报头集合，我们们可以根据这些报头获得主机名称、采用的缓存策略、浏览器相关信息、以及客户端支持的媒体类型（Media Type）、编码方式、语言和字符集等...Richard Stevens 我所理解的RESTful Web API [Web标准篇] 我所理解的RESTful Web API [设计篇]

1.5K110

我所理解的RESTful Web API

《我所理解的RESTful Web API [Web标准篇]》Web服务已经成为了异质系统之间的互联与集成的主要手段，在过去一段不短的时间里，Web服务几乎清一水地采用SOAP来构建。...该书中介绍了一些采用ROA架构的Web服务应该具备的基本特征，它们可以指导我们如果构架具体的RESTful Web API。...RESTful Web API采用面向资源的架构，所以在设计之初首先需要考虑的是有哪些资源可供操作。 资源是一个很宽泛的概念，任何寄宿于Web可供操作的“事物”均可视为资源。...方法 由于RESTful Web API采用了同一的接口，所以其成员体现为针对同一资源的操作。...Richard Stevens 我所理解的RESTful Web API [Web标准篇] 我所理解的RESTful Web API [设计篇]

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

    我的编码习惯 —— API 接口定义

    接口定义一定程度上能反应程序员的编程功底。列举一下工作中我发现大家容易出现的问题： 1. 返回格式不统一 同一个接口，有时候返回数组，有时候返回单个；成功的时候返回对象，失败的时候返回错误信息字符串。...出现复杂的输入参数 一般情况下，不允许出现例如json字符串这样的参数，这种参数可读性极差。应该定义对应的bean。...xxx return configService.add(); } 很多人看了我的这篇文章 程序员你为什么这么累？...有些人误解了，我那篇文章说的都不是技术，重点说的是编码习惯工作方式，如果你重点还是放在什么技术上，那我也帮不了你了。...同样，如果我后面的关于习惯和规范的帖子，你重点还是放在技术上的话，那是丢了西瓜捡芝麻，有很多贴还是没有任何技术点呢。

    93140

    我是如何根据豆瓣api来理解Restful API设计的

    REST本身跟http无关，但是目前http是与它相关的唯一实例。REST有着优雅、简洁的特性，本文是根据豆瓣api来谈谈自己对restful的一些理解。...不使用无意义的字符串、数字，要做到简洁。 3.正确使用method get -只用做资源的读取。 post-通过用作创建一个新的资源。 delete-通过用作资源的删除。...2xx: 请求正常处理并返回 3xx: 重定向 4xx: 客户端请求有错误 5xx: 服务端请求有错误 比如豆瓣api返回的状态码说明： 状态码 含义 说明 200 ok 请求成功 201 created...5.使用通用的错误码 通用错误码，具体产品由具体产品api给出。...8.参考资料 本文参考了以下的资料: 豆瓣api 理解restful架构 restful introduction 跟着github学习restful api设计 REST接口设计规范 restful

    2.3K50

    在Ubuntu上快速搭建基于Beego的RESTful API

    最近在研究Go，打算基于Go做点Web API，于是经过初步调研，打算用Beego这个框架，然后再结合其中提供的ORM以及Swagger的集成，可以快速搭建一个RESTful API的网站 下面是具体做法...版本，输入 go version 我当前返回的是go version go1.8.1 linux/amd64说明我们的Go 1.8已经安装成功 2....创建api项目并运行 直接使用bee工具创建一个简单的RESTful API项目是个不二的选择，假设我们的项目名字叫testApi，那么只需要执行： bee api testApi 那么程序就会创建对应的文件在目录...charset=utf8") } 这里需要注意的是数据库连接字符串和普通的写法不一样，要写成如下格式： 用户名:密码@tcp(MySQL服务器地址:端口)/数据库名字?...4.6 运行并通过Swagger测试 我们的编码已经完成。

    77210

    人人都是 API 设计者：我对 RESTful API、GraphQL、RPC API 的思考

    其一，我阅读了《阿里研究员谷朴：API 设计最佳实践的思考》一文后受益良多，前两天并转载了这篇文章也引发了广大读者的兴趣，我觉得我应该把我自己的思考整理成文与大家一起分享与碰撞。...其二，我觉得我针对这个话题，可以半个小时之内搞定，争取在 1 点前关灯睡觉，哈哈。 现在，我们来一起探讨 API 的设计之道。我会抛出几个观点，欢迎探讨。...在 RESTful API 中，API 接口应该尽量兼容之前的版本。...六、异常响应与错误机制 业内对 RPC API 抛出异常，还是抛出错误码已经有太多的争论。...一种比较好的方案是，当 RESTful API 接口出现非 2xx 的 HTTP 错误码响应时，采用全局的异常结构响应信息。

    1.3K20

    带有 Python REST Web 服务示例的 REST API 快速入门指南

    本篇涵盖以下三个高级概念： REST 基本概念——本节解释了 6 个关键的 REST 架构约束 RESTful 实现的关键元素 – 本节介绍 RESTful 实现的 6 个不同元素 创建 Python...按需编码 这表明有时客户端可以下载可执行代码而不是静态数据，即 JSON/XML。它增加了系统的可扩展性。...6 响应代码 这些编码与响应一起返回，并表示发送到服务器的请求的状态。这些类似于 HTTP 响应代码。例如，200 OK 表示请求成功，404 NOT FOUND 表示在服务器上找不到资源。...from flask import Flask from flask_restful import Resource, reqparse , api TGS = Flask(__name__) api...如果记录已存在，则返回错误代码 400 错误请求。 def post(self,category): PUT 方法将覆盖记录并返回数据以及响应代码 200 OK。

    3.2K00

    学习ElasticSearch的Restful Api快速掌握ES数据的增删改查

    如果写入成功，则它将请求并行转发到NODE1和NODE3的副分片上，等待返回结果。当所有的副分片都报告成功， NODE3 将向协调节点报告成功，协调节点再向客户端报告成功 。...如果Replica写入失败，ES会执行一些重试逻辑等，但最终并不强求一定要在多少个节点写入成功。在返回的结果中，会包含数据在多少个shard中写入成功了，多少个失败了。...2 Restful API 说明：以下所有操作均在本地启动ES服务器和Kibana服务器后通过登录http://localhost:5601网页的Console控制台中进行 2.1 创建空索引 PUT...5 小结 本文对使用ElesticSearch的Restful API进行简单的增删改查进行了详细地示例演示，并涉及简单的根据ID搜索、全量搜素和稍微复杂的DSL搜索，希望读者看完本文都能有切实的收获...下一篇文章，笔者将介绍使用Restful API对数据进行批量和聚合操作，敬请期待 参考阅读 鲁班学院分布式系统ElesticSearch学习笔记文档 https://www.yuque.com/books

    88010

    Restful API 吹的五大三粗，为啥我用不起来？缺一样工具

    一般的最佳实践就是使用API进行。那么在初期开发的时候，如何快速的测试接口的使用方式，或者快速的定位故障。有没有比较便捷的工具呢？ ? 今天我们要说的就是 curl 指令。这个工具非常强大。...对于接口调试所拥有的各项功能，而且各大编程语言所使用的底层网络请求库，通过它来实现的。 本文通过接口调试中常见的几种协议和传参方式，向大家介绍 curl 的快速用法。...如果我们传递的是一个 json 结构体的字符串，可以手动指定： curl -X POST -H "Content-Type: application/json" -d '{"userId": 5, "title...否则，API服务器将以“禁止访问”或“未经授权”的响应消息进行响应。获取访问密钥的过程取决于使用的API。...这是行业惯例以及API最佳实践。 使用 curl 的好处是我们可以随心所欲地随时调试，而不必构建一套程序。 Happy coding :_) 我是 @程序员小助手 ，持续分享编程知识，欢迎关注。

    1K20

    flask框架基本使用

    特别适合我这种非计算机专业人士学习，能快速搭建api，为前端web、微信小程序等提供api服务，非常nice，爱了爱了 ---- 安装 pip3 install Flask ---- 导入 from flask...data 包含了请求的数据，并转换为字符串，除非是一个Flask无法处理的mimetype。 files MultiDict，带有通过POST或PUT请求上传的文件。...有一个非常好用的库叫flask_restful，这可以非常简单的部署api服务。 flask_restful官方文档 restful api 不是技术，准确的说是一种规范。...Restful api 安装 pip install flask-restful Restful api 示例 from flask import Flask from flask_restful import...1, 2]) # matplot图保存在io流 buf = BytesIO() fig.savefig(buf, format="png") # io流转为base64编码的字符串

    87710

    雷电网络RESTful API手册中文版

    雷电网络（Raiden Network）是以太坊区块链的链下扩容方案，Raiden节点的Restful API官方文档中文版由汇智网提供，访问地址：http://cw.hubwiz.com/card/c...1、API请求/响应数据的JSON编码 API的访问请求与响应都采用JSON编码。下面是API中的常用对象。...，整数 partner_address：对方地址， EIP55编码的地址字符串，用来开启一个通道 token_address：代币地址，EIP555编码的代币地址字符串，用于通道上的交易 token_network_identifier...：代币网络标识符，EIP55编码的代币网络标识符 balance：可用代币余额，整数 total_deposit：已存入通道合约的金额，整数 state：通道的当前状态，字符串，可能的值包括：opened...2、API错误信息 对于不成功的API请求，会返回对应的http状态码，例如409冲突或400错误请求等，同时也会在返回的json对象中附带errors字段，你可以用来获取关于错误的详细信息。

    1.4K20

    5个REST API安全准则

    必须确保传入的HTTP方法对于会话令牌/API密钥和相关资源集合，操作和记录都是有效的。 例如，如果您有一个RESTful API的库，不允许匿名用户删除书目录条目，但他们可以获得书目录条目。...3 - 输出编码 （1）安全头部 为了确保指定资源的内容被浏览器正确解释，服务器应始终发送带有正确Content-Type的Content-Type头，并且Content-Type头最好包含一个字符集...（3）XML编码 XML绝不应该由字符串连接构建。 它应该始终使用XML序列化器构造。 这确保发送到浏览器的XML内容是可解析的，并且不包含XML注入。...当设计REST API时，不要只使用200成功或404错误。 以下是每个REST API状态返回代码要考虑的一些指南。 正确的错误处理可以帮助验证传入的请求，并更好地识别潜在的安全风险。...403“禁止”的真正含义未经授权，“我明白您的凭据，但很抱歉，你是不允许的！” 概要 在这篇文章中，介绍了5个RESTful API安全问题和如何解决这些问题的指南。

    5.1K10

    我在Android应用中发现硬编码的Facebook和Google API密钥（以及为什么这是个坏主意）

    我在Android应用中发现硬编码的Facebook和Google API密钥（以及为什么这是个坏主意）☕ 逆向分析APK很有趣...直到你发现生产环境密钥就这么赤裸裸地躺在代码里。...内容提要在分析一个公开的Android APK时，我直接在应用的strings.xml文件中发现了硬编码的Facebook和Google API凭证。...✅ Google API密钥验证尝试使用该密钥调用地理编码API：curl "https://maps.googleapis.com/maps/api/geocode/json?...密钥：按应用包名和SHA-1指纹限制仅开放必要API权限 核心原则：只要存在于APK中的内容，就不算秘密。‍...给漏洞赏金猎人的建议分析APK时务必：检查strings.xml、AndroidManifest.xml和.smali文件关注AIza、facebook_client_token等特征字符串道德验证密钥有效性负责任披露并脱敏公开报告

    31010

    REST vs RPC - RESTful究竟是什么？

    一 好烦啊，分不清REST RPC RESTful的区别,所以只能翻译一篇谷歌的文章，括号中是我的补充 原文连接 REST vs RPC - What is RESTful?...同样，HTTP带有标准错误代码，MIME(Multipurpose Internet Mail Extensions)类型可以完成大部分繁重工作。...返回的状态码是手工编码的，也是你定义的一部分。 -相反，REST API将问题域中的各种实体建模为资源，并使用HTTP谓词来表示针对这些资源的事务 -  POST创建，PUT更新和GET读取。...RESTful API的具体实现则是 资源---url本身就是名词，而不含有动词 错误 /getLoginInfo 正确 /loginInfo 使用或采取行动----略 不是客户端和服务器之间通信的实现细节...---使用http的状态码来描述请求状态而不是自定义code 例如这种常见的返回对象是不符合RESTful API的 { 　　code：001 　　message：密码错误 　　data：{ 　　}

    1.7K50
    点击加载更多

    相关资讯

    热门标签

    更多标签

    活动推荐

      运营活动

      活动名称
      广告关闭

      腾讯云开发者

      扫码关注腾讯云开发者

      扫码关注腾讯云开发者

      领取腾讯云代金券

      热门产品

      热门推荐

      更多推荐

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

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

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

      领券