apistar

？ Web API 工具包。 ？

---

社区： https://discuss.apistar.org？ ？ ？ ？

文档： https://docs.apistar.com

要求： Python 3.6+

---

API Star 是一个用于使用 OpenAPI 或 Swagger 模式的工具包。它允许您：

• 构建 API 文档，并选择可用的主题。
• 验证 API 架构文档，并提供上下文错误。
• 使用动态客户端库发出 API 请求。

您可以使用它来构建静态文档，将其集成到 Web 框架中，或者将其用作与其他 API 交互的客户端库。

快速入门

安装 API 之星：

$ pip3 install apistar

让我们看一下该工具包提供的一些功能......

我们首先创建一个 OpenAPI 架构schema.yaml ：

 openapi : 3.0.0
info :
  title : Widget API
  version : ' 1.0 '
  description : An example API for widgets
servers :
  - url : https://www.example.org/
paths :
  /widgets :
    get :
      summary : List all the widgets.
      operationId : listWidgets
      parameters :
      - in : query
        name : search
        description : Filter widgets by this search term.
        schema :
          type : string

我们还创建一个配置文件apistar.yml ：

 schema :
  path : schema.yaml
  format : openapi

我们现在准备开始使用apistar命令行工具。

我们可以验证我们的 OpenAPI 架构：

 $ apistar validate
✓ Valid OpenAPI schema.

或者为我们的 API 构建开发人员文档：

 $ apistar docs --serve
✓ Documentation available at "http://127.0.0.1:8000/" (Ctrl+C to quit)

我们还可以向架构中引用的服务器发出 API 请求：

 $ apistar request listWidgets search=cogwheel

服务器去哪儿了？

从 0.6 版开始，API Star 项目专注于与框架无关的 API 工具套件。该计划的目的是构建此功能，使其适合作为独立工具使用，或与大量框架一起使用。

0.5 分支在 GitHub 上仍然可用，并且可以使用pip install apistar==0.5.41从 PyPI 安装。 API Star 服务器的任何进一步开发可能都需要在新的维护者的领导下进行分叉。

如果您正在寻找一个基于 Python 的高性能异步框架，那么我会推荐 Starlette。

---

API Star 是 BSD 许可代码。
在英国布莱顿设计和建造。