了解REST API并安装Api Platform-Symfony5全面开发

您需要登录后才可观看此视频

为了更好的为您提供服务,请您登录后再查看本课程。

立即登录 注册账号

我这里找到了一些关于API介绍的文章,我们有必要看一下。我们在学习API时,通常会看到一些资料中会提到RESTful API。我们来了解一下。

#关于RESTful API的介绍请看
https://www.redhat.com/zh/topics/api/what-is-a-rest-api

REST API也称为RESTful API,它是遵循REST架构规范的应用编程接口,我们继续往下看。REST是一组架构规范,并非协议或者标准,所以我们在使用不同系统的API时,它们的API并不是统一的。我们可以使用REST这种架构规范来规范我们的API设计。当客户端通过RESTful API提出请求时,它会将资源状态表述传递给请求者或者终端,请求的信息可以使用多种格式。

我们继续往下看,在发送请求时,请求头和参数也都很重要,因为请求头或者参数中包含了请求的元数据、授权,统一资源标识符等等重要信息。我们往下看,我们要设计遵循REST规范的API的话需要遵循以下标准: 客户端服务器架构由客户端服务器和资源组成,并且通过HTTP管理请求。API的请求是无状态的请求。get请求期间不会存储任何客户端的信息。每个请求都是独立的,互不关联。然后是可缓存性数据,用来简化客户端和服务器之间的交互。然后是组件之间的统一接口,是信息以标准的形式进行传输。我们马上就要设计有统一接口的API了。

继续往下看,组织各种类型服务器的分层系统,会将参与请求的信息检索到对客户端不可见的层次结构中。最后是按需编码,根据请求将代码从服务器端发送到客户端,从而扩展客户端功能。

我们搜索symfony api,查看symfony.com网站。这里有段关于API Platform的介绍,我们查看一下翻译。API Platform是一个用于开发API的开源web框架。这里介绍了很多,我们可以直接下载API Platform,然后使用API Platform来创建REST规范的接口。

但是这里我们需要让API Platform和我们的Symfony项目进行集成。打开symfony.sh,我们搜索api,在这里有个api-pack。我们可以通过安装这个包,来让API Platform和我们的Symfony项目进行集成。

回到项目,输入composer req api。安装完成之后,我们回到浏览器,打开127.0.0.1:8000端口,后面添加/api。我们看到API组件自动的为我们添加了一个/api路由路径,并且显示了openapi接口文档页面。

在下节课,我们来创建文章类的接口。

课程讨论

当前内容评论功能已关闭。