跳转到主要内容

更轻松地手工定制您的艺术REST请求。

项目描述

更轻松地手工制作艺术REST请求。

您是否发现自己通过打开Python、Ruby或JavaScript repl或手工构建curl请求来手工制作REST请求?您是否觉得记住每个服务所需的头信息、请求格式和认证规则非常繁琐?这个库就是为您准备的。

Benzo通过提供一些功能,使构建和迭代常见请求类型的过程变得简单易行:

  • 模板化请求:无论是通用(json、yaml或表单编码)还是特定于服务的模板化请求,都可以让您轻松定义要发送的内容。

  • 简单直观的创建请求。您的请求内容及其属性(如URL、请求方法和头信息)将在您的默认编辑器中显示,您可以随意添加、修改或删除参数。

  • 将API有效载荷与编辑器格式分离。尽管您交互的API可能需要表单编码、JSON或yaml值,但您可以使用多种格式编辑请求,benzo将在发送请求时将其转换为正确的格式。

  • 可保存会话。您是否曾经完美地构建了请求?我没有。使用benzo的会话快速轻松地迭代您的请求。如果您第一次不成功,只需在同一会话中重新运行benzo,编辑器将打开成您最后离开时的样子。

安装

使用pip安装

pip install benzo

用法

您可以直接运行benzo,但真正的威力来自于使用会话或内置模板之一。

会话

您可以使用命令行参数 --session=<文件路径> 为您的请求保存一个会话。在使用会话时,使用相同会话文件的后续请求不仅会继续使用相同的实际会话(包括之前连接的服务器发送的任何cookie),而且当打开编辑器时,会显示您之前发出的确切请求。这使得迭代处理特别棘手的请求变得非常容易。

模板

您可以使用 --template=<模板名称> 命令行参数使用请求模板。可用的模板包括

  • yamljsonform:这些是通用的REST请求模板,可以分别以Yaml、JSON或表单编码格式构建API有效载荷。

  • urbanairship.push:这将提供一个空白模板,您可以使用Urban Airship API发送推送。

    • 此模板还允许在您的 ~/.benzo 文件的 [urbanairship] 部分中设置一些配置设置

      • app_key:请求时默认使用的Urban Airship App Key。

      • master_secret:请求时默认使用的Urban Airship Master Secret。

  • twilio.sms:这将提供一个空白模板,您可以使用Twilio API发送短信通知。

    • 此模板允许在您的 ~/.benzo 文件的 [twilio] 部分中设置一些配置设置

      • account_sid:请求时默认使用的Twilio Account SID。

      • auth_token:请求时默认使用的Twilio Auth Token。

编辑您的请求

参数

请求模板通常会在编辑器顶部显示为注释的各种参数。参数通常包括诸如 MethodURL 之类的项目,但各个模板可能提供额外的参数。这些参数可以在发送之前进行编辑,以改变请求的行为。

头部

请求模板通常会在编辑器顶部附近作为注释显示一系列额外头部,以 [Header] 开头。您可以随意更改或添加额外的头部;只需确保在行首使用 [Header] 关键字,这样benzo就知道哪些行应该被解释为头部。

取消

如果您希望在编辑器打开后中止请求,只需删除文件中的所有内容,保存并退出。

配置

您不需要提供任何特殊配置细节,但您可以通过在 ~/.benzo 文件的 [benzo] 部分中添加配置设置来微调benzo的行为。

  • default_editor_format:您想使用哪种格式来构建API请求?我建议将此设置为 yaml 以便更人性地编辑API请求。默认:json

  • default_template:如果您没有指定要使用的模板,应使用哪个模板来生成您的请求?默认:json

请注意,各个模板可能定义额外的配置设置;有关更多信息,请参阅 模板

项目详情


下载文件

下载适用于您的平台的文件。如果您不确定选择哪个,请了解更多关于安装包的信息。

源分布

benzo-0.1.0.tar.gz (8.3 kB 查看哈希值)

上传时间

由以下支持