Core API - 一种定义 Schema&Response 的格式

查看原文

Core API 是一种展示 Web API 的文档对象模型 (Document Object Model)。 Core API 提供了客户端可以让你更简单地发起请求和解析相应。简单来说,它给 RESTful API 套上了一层更接近 function call 风格的接口。

  • 可以通过 pip install coreapi 获得命令行工具
  • 示例:
    • coreapi action notes 0 delete 删除 id=0 的笔记
    • coreapi action add_note --params description="Email venue about conference dates" 添加一个笔记
    • coreapi action notes 0 edit --params complete=true 修改一个笔记
    • coreapi show notes 0 description 查看某个字段
  • 跟别的工具不一样的是,它定义了三层概念:Document / Encoding / Transport 分别用在模型定义,数据编码,和数据传输上。由于格式无关,它可以用在 restful api / graphql / grpc 等各种数据接口上。