HTTP(s) API 经验总结
参考文章
https://developer.mozilla.org/zh-CN/docs/Web/HTTP/Overview
First
首先,需要了解HTTP(s)请求,其主要包含那几个重要部分。各个部分具有什么功能。第一个需要了解的URI和URL。URL时URI的子集,这里只需要掌握URL的知识即可。
除了URL这个基础之外,http(s)还可以通过Header传递信息,如果不熟悉,可以复习一下http/https报文的结构。Header一般传递一些与传输相关的内容,比如所传输的信息的类型,信息的长度等等(但也不完全是)。在API调用中,这个部分一般用于鉴定请求者的身份,比如token的验证方式。一般在API文件中会详细的规定出请求所需要的参数。
除了Header之外,在请求的过程中,另一个中重要的概念就是请求方式了,常见的请求方式有GET,POST。其他的请求方式我们一般来说了解比较少,不过在API请求中,GET和POST的使用相对居多,其他请求方式在一些文件上传和管理中也会涉及部分。
一个HTTP(s) API请求的主要是这三个部分:请求方式,URL,Header。(按照http/https报文的顺序,本文按照URL,Header,强求方法的顺序来介绍,主要是请求方法相对简单,大家对其相对了解)
URL
一个完整的URL如下:
protocol://hostname[:port]/path/[;parameters][?query]#fragment
这里面用几个重要的概念:比如 query
, fragment
。
- protocol: 协议,这里可以是http/https
- hostname: 主机地址,也就是服务器地址,这里可以是域名或者IP。
- path: 资源路径,指的是主机对应资源的地址。不过在api中可以将其视为一个参数,常常可以作为对象路径或者请求方法。
- parameters: 参数,这是用于指定特殊参数的可选项。这个目前我还没见过。
- query: 查询,可以向服务器显示的传递参数,一般以
?
开头。多个参数以&
相连,参数采用键值对,中间以=
相连。 - frament: 信息断片,常常出现在各种文档类网站中,用于标记title位置。
除了URL之外,http(s)还可以通过http-header传递信息。
HTTP(s)-Header
HTTP header(HTTP 首部) - 术语表 | MDN (mozilla.org)
HTTP header(HTTP 首部,HTTP 头)表示在 HTTP 请求或响应中的用来传递附加信息的字段,修改所传递的消息(或者消息主体)的语义,或者使其更加精确。消息首部不区分大小写,开始于一行的开头,后面紧跟着一个 ':'
和与之相关的值。字段值在一个换行符(CRLF)前或者整个消息的末尾结束。
Header可以根据不同的作用分为下面几种类型:
- General header:公共头部,可以应用于请求和响应中,但是与在消息主体中的数据无关。
- 在请求头和响应都存在。
- 最常见的通用首部包括:
Date
、Cache-Control
或Connection
- Request header:请求头部,含有与所要获取的资源或者客户端自身相关的附加信息。
- 在API中,可以作为验证请求身份的一个标识,用于鉴权。比如token, cookie(少用)。
- 用于表明请求方对相应内容的一些要求,比如语言类型,编码方式等。
- Response header:响应头部,含有与响应相关的附加信息,比如它的位置或者与服务器相关的信息(名称、版本号等)。
- 一般是服务器向请求方返回的HTTP的头部信息。
- 可以设置cookie。
- Entity header: 实体头部,含有与消息主体相关的附加信息,比如长度或者MIME类型。
- 可以标注返回内容的形式,比如application/json,就是json格式数据。
- MIME包含了我们常见的数据形式,包括图像,视频和各类文本形式。
在API请求中,我们在意的一般是Request Header(请求头部),一般API文档会告诉我们如何设定头部参数,一般用于鉴权和请求内容说明(MIME类型,长度,hash之类)。
请求方式
HTTP 请求方法 - HTTP | MDN (mozilla.org)
- GET : GET方法请求一个指定资源的表示形式,使用GET的请求应该只被用于获取数据。
- HEAD : HEAD方法请求一个与GET请求的响应相同的响应,但没有响应体。
- POST : POST方法用于将实体提交到指定的资源,通常导致在服务器上的状态变化或副作用。
- PUT : PUT方法用请求有效载荷替换目标资源的所有当前表示。
- DELETE : DELETE方法删除指定的资源。
- 其他参考: HTTP 请求方法 - HTTP | MDN (mozilla.org)
在API调用时,其实各种方法没有差异,可以理解为是一种人为规定,只需要按照API文档的方法进行请求就可以了。
在设计API时,可以根据功能的需要,选择设置不同的请求方式。
HTTP(s) API 经验总结的更多相关文章
- C#调用百度地图API经验分享(一)
最近客户提了一个需求,要在网站中添加百度地图的显示,其实原来是有谷歌地图的,但由于谷歌在大陆遭到封杀,只好再给用户增加一个选择了. 下面我将自己最近整理的一些知识分享给大家. 如何使用百度地图API: ...
- C#调用百度地图API经验分享(四)
这一篇,记录一下我调用的地图API实现的功能.下面介绍的都是一些片段的节选,不能直接复制就运行.在实现之前肯定要加载地图,先放一个webbroser控件,然后如下: private void Form ...
- C#调用百度地图API经验分享(三)
这一篇我将跟大家分享一下我自己在开发过程中总结出的一些操作地图的方法,属性,及思路,希望可以让大家少走弯路. 1.定位 一般百度的示例DEMO里开始初始化地图时用的都是map.centerAndZoo ...
- C#调用百度地图API经验分享(二)
接着上一篇,将上一篇代码的js提取出来:<script type="text/JavaScript">var map = new BMap.Map("allm ...
- Html5 Device API详解
三.四月曾学习过html5相关知识,并就html5 device api做过一次讲解 课程时长一个小时,预期达到level 200目标,即知道html5 device api是什么,且知道怎么实现 面 ...
- 第二篇:Entity Framework CodeFirst & Model 映射
前一篇 第一篇:Entity Framework 简介 我有讲到,ORM 最关键的 Mapping,也提到了最早实现Mapping的技术,就是 特性 + 反射,那Entity Framework 实现 ...
- 透明的LISTVIEW
.NET就是封装的太密了,有时很多时候让我们反而更麻烦,特别是COPY不到的时候,又不懂自已想的话,说土一点就是死路一条, 记得以前经常用一句话,C++支持,可C#他不支持啊!就这样安慰自已 其实做多 ...
- Web API接口设计经验总结
在Web API接口的开发过程中,我们可能会碰到各种各样的问题,我在前面两篇随笔<Web API应用架构在Winform混合框架中的应用(1)>.<Web API应用架构在Winfo ...
- Web API系列(一)设计经验与总结
在移动互联网的时代, Web服务已经成为了异构系统之间的互联与集成的主要手段,各种 Web服务几乎都采用REST风格的Web Api来构建. 通过Http协议的形式来. 以Get/Post方式发送请求 ...
随机推荐
- 使用Python批量爬取美女图片
运行截图 实列代码: from bs4 import BeautifulSoup import requests,re,os headers = { 'User-Agent': 'Mozilla/5. ...
- 【java】非常多!学习路径24-总结目前所有知识(上)
感谢sikiedu.com的siki老师.几年前就开始看siki的课程,最近突然想写这个笔记系列,顺便回顾一下这些基础的知识,同时也希望能帮助到一些人,有问题一起交流哈. 全文共十章,大约1.5万字, ...
- 在Laravel框架blog中,终端的一些命令
创建控制器php artisan make:controller TestController数据库迁移php artisan make:migration create_goods_table实行迁 ...
- KingbaseES 绑定变量与游标共享
对于重复执行的SQL,需要使用绑定变量,避免SQL的重复解析.但是,并不是说使用了绑定变量,就一定能避免硬解析.具体可以参见:https://www.cnblogs.com/kingbase/p/16 ...
- docker-compose总结
docker-compose.yml 样例: 各个标签的含义在注释里 version: '3' # 选择的docker-compose 版本 services: # 要编排的一组服务 fim-mysq ...
- 腾讯云实验室 Gitea 互动教程上线啦
如果你想学习.体验或是向他人演示开源的 Gitea 代码托管方案,那么接下来给你推荐一款神器. 使用腾讯云实验室免费获得 Gitea 实验环境,直接通过浏览器就可在 Ubuntu Server 20. ...
- 《Win10——常用快捷键》
Win10--常用快捷键 Ctrl+C:复制 Ctrl+V:粘贴 Ctrl+A:全选 Ctrl+X:剪切 Ctrl+D:删除 Ctrl+Z:撤销 Ctrl+Y:反撤销 Ctrl+Shift ...
- Java SE 四大内部类
内部类 1.成员内部类 调用成员内部类 //在外面的类的最后,写一个方法,调用成员内部类(创建对象,在访问) class Outer08{ class Inner08{ //成员内部类 public ...
- 利用分层机制优化 Docker Image
文章转载自:https://mp.weixin.qq.com/s/FrIOIquHVsCTEMfHiF87MA 假设系统中我们有两个应用 App1 和 App2.这两个节点的环境信息如下: 通过上表环 ...
- 路径参数和数值校验: Path_Parameters_and_Numeric_Validations
官方文档地址: https://fastapi.tiangolo.com/zh/tutorial/path-params-numeric-validations/ # -*- coding: UTF- ...