使用api buddy从控制台探索api

api-budd的Python项目详细描述


API好友

Build StatusPyPI version

Demo

Right now, only OAuth2 authentication is supported. It's the most common, and current gold standard for security best practices. Also most APIs use it. That said, I have no beef with all the APIs out there using something else, so feel free to open a ticket if you want something else supported. ?

You can also always manually set headers.

安装

只要你有python 3.7或更高版本(我建议使用pyenv),只要:

pip install api-buddy

用法

首先,在首选项中指定您正在探索的api

# ~/.api-buddy.yamlapi_url:https://some.api.com

那就很简单了:

api get some-endpoint
=>200{"look":"I haz data","thx":"API Buddy"}

http方法默认为get

api this-endpoint  # same as first example

您可以添加key=val格式的查询参数:

api get \
  my/favorite/endpoint \first_name=cosmo \last_name=kramer

您还可以添加json格式的请求正文数据:

api post \
  some-endpoint \'{"id": 1, "field": "value"}'

注意单引号。您可以跨多行展开此帐户:

api post \
  some-endpoint \'{     "id": 1,     "field": "value"  }'

Preferences ?

参数

  • http_method:(可选,默认值=get)要在请求中使用的http方法。
    • 它应该是:
      • get
      • post
      • patch
      • put
      • delete
  • endpoint:(必选)到api端点的相对路径。
    • 也就是说,您不需要在这里再次键入基本api url。
  • params:(可选)查询参数列表key=val
  • data:(可选)请求正文数据的json字符串。
    • 您不能将此与get一起使用,因为http。

选项

  • -h--help:显示帮助消息
  • -v--version:显示安装的版本

开发

需要:

开始工作的步骤:

  • 使用bin/setup
  • 构建并创建本地venv
  • 确保一切都与bin/test
  • 一起工作
  • 使用poetry run api --help
  • 尝试本地cli
  • 使用bin/list
  • 查找其他管理命令

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
java HikariCP连接池Tomcat调试启用   java如何在javascript中访问JSON数组的元素?   jasper使用HttpServlet报告Java空白PDF   用于存储海量数据的java最佳集合   JBPM&springboot组织。流口水。坚持不懈jta。JtaTransactionManager在JNDI位置[java:comp/UserTransaction]未找到任何UserTransaction   java Grails maven插件需要Groovy 2.4.2   获取列表中访问最少的元素(Java 8)   java在IntelliJ中下载cn1lib不起作用   java Akka构造函数通过spring进行布线   swing在Java中创建JList时,如何更改条目的背景颜色?   为什么Java8Lambda允许访问非最终类变量?   javajavax。邮政MessaginException:无法连接到SMTP主机   java Android Webview高度在滚动后增加