Api platform 教程2---Swagger UI:交互式文档

Mario Sanchez

19 people read
Thumbnail

Api platform 教程2---Swagger UI:交互式文档

所谓的API文档其实并不是来自于api-platform,实际上是一个名叫Swagger UI 的开源 API 文档库,Swagger UI 真正酷的一点是,如果有人创建一个描述任何 API 的文件,那么该 API 就可以免费获得所有这些!我喜欢免费的东西!我们获得 Swagger UI 是因为 API 平台提供了开箱即用的描述文件。但稍后会详细介绍。

使用我们的新 API

我们在POST下面点击"Try it out",在request body里为每一个字段填写相应的值,然后点击"Execute". 可以看到返回了201,然后在Response body中显示了提交后返回的所有信息。包括了@context 、 @id 和 @type。

现在在去第一个GET里取所有宝藏,page=1是可选项,是不是看到了刚才我们所提交的数据?

因此,只需几分钟的工作,我们就为 Doctrine 实体提供了功能齐全的 API。太棒了。

可是路由是从哪里来的呢?

显然我们有一个以/api开头的路由,但这些是从哪里来的呢?又是如何动态添加到我们应用中的?

其实我们在安装api platform时,自动为我们添加了一个config/routes/api_platform.yaml文件

api_platform:
    resource: .
    type: api_platform
    prefix: /api

About Me

我是一位精通 Symfony 框架和 API Platform 的开发者,擅长构建高效、可扩展的 Web 应用程序和 API。 此外,我还具备 PrestaShop 模块开发经验,能够为您的电商平台定制功能,满足特定业务需求。