使用API
学习了如何构建API后,接下来我们学习如何测试和使用API。
API预览
点击右上角"API预览ICON",打开swagger文档页。
![](https://docs.fireboom.io/~gitbook/image?url=https%3A%2F%2F2707494476-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FNx22Cp3wzkuW1siRbMwW%252Fuploads%252Fgit-blob-ba2725b8d951d1923cf7a55603616020bccd357d%252Fimage%2520%2851%29.png%3Falt%3Dmedia&width=768&dpr=4&quality=100&sign=ac0eecd2&sv=1)
左侧为API列表,以文件夹作为分组名,未分组API位于Others分组,此外,还包含FileUpload分组,用于展示OSS对应的路由。
选择对应API,可以查看其Operation,输入入参后,点击“TRY”按钮,可进行测试。响应栏会展示响应状态码和响应结果。
若API需要授权才能访问,需要在右上角选择对应OIDC,进行登录。登录后可查看当前登录用户的基本信息。
此外,若想在POSTMAN等工具测试,点击“下载”按钮,可获取swagger文档。
REST 对接
上述文档展示了所有的API列表,可手工编写任意客户端的代码,对接接口。
值得注意的是,对于GET请求的对象入参,要用JSON字面量的方式传入,详情参考 路由规则
SDK生成
除了上述方式外,也可以使用Fireboom生成对应客户端的SDK,提升API对接速度!
若想在客户端使用API,可点击状态栏“客户端模板”,浏览”模板市场“,选择对应”客户端模板“下载,例如TS SDK、Flutter SDK,并配置生成路径。
前往对应路径查看生成的SDK,然后在项目中引用对应语言的客户端SDK,即可使用。
更多详情,前往客户端SDK。
最后更新于