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 授權代碼。
在英國布萊頓設計和建造。