apistar

? Das Web-API-Toolkit. ?

---

Community: https://discuss.apistar.org ? ? ? ?

Dokumentation: https://docs.apistar.com

Anforderungen: Python 3.6+

---

API Star ist ein Toolkit für die Arbeit mit OpenAPI- oder Swagger-Schemas. Es ermöglicht Ihnen:

• Erstellen Sie eine API-Dokumentation mit einer Auswahl verfügbarer Themen.
• Validieren Sie API-Schemadokumente und stellen Sie kontextbezogene Fehler bereit.
• Stellen Sie API-Anfragen mithilfe der dynamischen Clientbibliothek.

Sie können damit eine statische Dokumentation erstellen, sie in ein Web-Framework integrieren oder sie als Client-Bibliothek für die Interaktion mit anderen APIs verwenden.

Schnellstart

API Star installieren:

$ pip3 install apistar

Werfen wir einen Blick auf einige der Funktionen, die das Toolkit bietet ...

Wir beginnen mit der Erstellung eines OpenAPI-Schemas, 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

Lassen Sie uns auch eine Konfigurationsdatei apistar.yml erstellen:

 schema :
  path : schema.yaml
  format : openapi

Jetzt können wir mit der Verwendung des Befehlszeilentools apistar beginnen.

Wir können unser OpenAPI-Schema validieren:

 $ apistar validate
✓ Valid OpenAPI schema.

Oder erstellen Sie eine Entwicklerdokumentation für unsere API:

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

Wir können auch API-Anfragen an den Server stellen, auf den im Schema verwiesen wird:

 $ apistar request listWidgets search=cogwheel

Wo ist der Server geblieben?

Ab Version 0.6 wird das API Star-Projekt als Framework-unabhängige Suite von API-Tools fokussiert. Der Plan besteht darin, diese Funktionalität so auszubauen, dass sie entweder als eigenständiges Tool oder zusammen mit einer Vielzahl von Frameworks verwendet werden kann.

Der 0.5-Zweig bleibt auf GitHub verfügbar und kann von PyPI mit pip install apistar==0.5.41 installiert werden. Jede Weiterentwicklung des API Star-Servers müsste wahrscheinlich gegen eine Abzweigung davon unter einem neuen Betreuer erfolgen.

Wenn Sie nach einem leistungsstarken Python-basierten asynchronen Framework suchen, würde ich stattdessen Starlette empfehlen.

---

API Star ist BSD-lizenzierter Code.
Entworfen und gebaut in Brighton, England.