apistar

? La boîte à outils de l'API Web. ?

---

Communauté : https://discuss.apistar.org ? ? ? ?

Documentation : https://docs.apistar.com

Exigences : Python 3.6+

---

API Star est une boîte à outils pour travailler avec les schémas OpenAPI ou Swagger. Il vous permet de :

• Créez une documentation API, avec une sélection de thèmes disponibles.
• Validez les documents de schéma d'API et fournissez les erreurs contextuelles.
• Effectuez des requêtes API à l'aide de la bibliothèque client dynamique.

Vous pouvez l'utiliser pour créer une documentation statique, l'intégrer dans un framework Web ou l'utiliser comme bibliothèque client pour interagir avec d'autres API.

Démarrage rapide

Installez l'API Star :

$ pip3 install apistar

Jetons un coup d'œil à certaines des fonctionnalités fournies par la boîte à outils...

Nous allons commencer par créer un schéma 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

Créons également un fichier de configuration apistar.yml :

 schema :
  path : schema.yaml
  format : openapi

Nous sommes maintenant prêts à commencer à utiliser l'outil de ligne de commande apistar .

Nous pouvons valider notre schéma OpenAPI :

 $ apistar validate
✓ Valid OpenAPI schema.

Ou créez une documentation pour les développeurs pour notre API :

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

On peut également faire des requêtes API au serveur référencé dans le schéma :

 $ apistar request listWidgets search=cogwheel

Où est passé le serveur ?

À partir de la version 0.6, le projet API Star se concentre sur une suite d'outils API indépendante du framework. Le plan est de développer cette fonctionnalité de manière à ce qu'elle soit appropriée pour une utilisation soit en tant qu'outil autonome, soit avec une large gamme de frameworks.

La branche 0.5 reste disponible sur GitHub et peut être installée depuis PyPI avec pip install apistar==0.5.41 . Tout développement ultérieur du serveur API Star devrait probablement s'appuyer sur un fork de celui-ci, sous la direction d'un nouveau responsable.

Si vous recherchez un framework asynchrone hautes performances basé sur Python, je recommanderais plutôt Starlette.

---

API Star est un code sous licence BSD.
Conçu et construit à Brighton, en Angleterre.