apistar

? Web API ツールキット。 ?

---

コミュニティ: https://discuss.apistar.org ? ? ? ?

ドキュメント: https://docs.apistar.com

要件: Python 3.6+

---

API Star は、OpenAPI または Swagger スキーマを操作するためのツールキットです。これにより、次のことが可能になります。

• 利用可能なテーマを選択して API ドキュメントを作成します。
• API スキーマ ドキュメントを検証し、コンテキスト エラーを提供します。
• 動的クライアント ライブラリを使用して API リクエストを作成します。

これを使用して静的ドキュメントを構築したり、Web フレームワーク内に統合したり、他の API と対話するためのクライアント ライブラリとして使用したりできます。

クイックスタート

API Star をインストールします。

$ 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 ライセンスコードです。
イギリスのブライトンで設計、製造されました。