Swagger 是一个特殊的工具,它可以自动组成 RESTful API你的应用程序的文档。

它的优势在于,它不仅允许你查看应用程序的所有端点,而且还可以通过发送请求和接收响应立即测试它们的运行情况。

要访问 Swagger,你需要在已发布的应用程序中按下 Preview按钮,然后点击所需发布计划的名称(Deploy Plan).

swagger access

在新打开的窗口中,会显示可用的端点和与这些端点相关的方法的列表。有些请求只对某些授权用户组可用(见 MiddlewareAuth module中每个具体请求的 Endpoints部分)。A Bearer Token对于只允许授权用户使用的请求,需要使用A。

你可以直接访问相应的端点,在 Swagger中的相应端点,以获得该令牌(Auth节。 POST /auth请求)。

swagger authorize

Try it out并输入登录名和密码以获得令牌。

请求将被发送至 Execute.如果发送成功,你会看到一个 token字段,其中有 Bearer token值。

获得授权用户令牌的第二种方式是,可以在部署的应用程序的请求体中找到令牌。

  1. 在你的网络浏览器中按F12键,打开开发者工具。
  2. 在你部署的应用程序中发送任何请求(例如,更新表)。发送该请求的用户必须被授权访问该端点。
  3. 打开 Network标签并找到相应的请求。
  4. 转到 Headers标签,并找到 Request Headers节。 Bearer token将呈现在 Authorization.

bearer token

提供 Bearer tokenSwaggerAuthorize并粘贴你在上一步骤中复制的值。

对于测试请求,选择所需的组和你想执行的方法。按 Try it out并填写请求的输入参数。点击 Execute来执行响应。

如果请求被服务器正确处理,最期望的响应是代码200,并显示响应结构应该是什么样子。

response 200

  • 401 - 该请求没有成功完成,因为所需的授权令牌丢失或无效。

    response 401

  • 404 - 请求被成功处理,但没有找到所请求的资源。

    response 404

  • 422 - 错误的参数被传递到请求的输入端。

    response 1200

  • 500 - 服务器处理请求时出现错误。

    response 500

引起自定义错误

对于自定义BP和相关请求,可以使用BP编辑器中的 Raise Error块创建带有描述的自定义错误代码。下面是这种过程的一个例子。

example

在这种情况下,如果对与上述BP相关的端点的请求失败,服务器将发出一个418错误,包含执行BP时的错误文本 DB: Create Candidate block.本例中的错误代码可以是用户指定的任何一个。

注意:HTTP 418 I'm a teapot client error response code表示服务器拒绝冲泡咖啡,因为它是,永久的,一个茶壶。一个暂时没有咖啡的组合咖啡/茶壶应该转而返回503。这个错误是指1998年和2014年愚人节笑话中定义的Hyper Text Coffee Pot Control Protocol

Was this article helpful?

AppMaster.io 101 速成班

10 模块
2 周数

不知道从哪里开始?通过我们的初学者速成课程,从A到Z探索AppMaster。

开始课程
Development it’s so easy with AppMaster!

需要更多帮助?

在我们专家的帮助下解决任何问题。节省时间并专注于构建您的应用程序。

headphones

联系支持

告诉我们您的问题,我们会为您找到解决方案。

message

社区聊天

在我们的聊天中与其他用户讨论问题。

加入社区