apistar

? El kit de herramientas API web. ?

---

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

Documentación: https://docs.apistar.com

Requisitos: Python 3.6+

---

API Star es un conjunto de herramientas para trabajar con esquemas OpenAPI o Swagger. Te permite:

• Cree documentación API, con una selección de temas disponibles.
• Valide documentos de esquema de API y proporcione errores contextuales.
• Realice solicitudes de API utilizando la biblioteca de cliente dinámico.

Puede usarlo para crear documentación estática, integrarla dentro de un marco web o usarlo como biblioteca cliente para interactuar con otras API.

Inicio rápido

Instalar API estrella:

$ pip3 install apistar

Echemos un vistazo a algunas de las funciones que proporciona el kit de herramientas...

Comenzaremos creando un esquema 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

Creemos también un archivo de configuración apistar.yml :

 schema :
  path : schema.yaml
  format : openapi

Ahora estamos listos para comenzar a usar la herramienta de línea de comandos apistar .

Podemos validar nuestro esquema OpenAPI:

 $ apistar validate
✓ Valid OpenAPI schema.

O cree documentación para desarrolladores para nuestra API:

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

También podemos realizar solicitudes de API al servidor al que se hace referencia en el esquema:

 $ apistar request listWidgets search=cogwheel

¿A dónde fue el servidor?

A partir de la versión 0.6, el proyecto API Star se centra en un conjunto de herramientas API independiente del marco. El plan es desarrollar esta funcionalidad de una manera que la haga apropiada para su uso como herramienta independiente o junto con una amplia gama de marcos.

La rama 0.5 permanece disponible en GitHub y se puede instalar desde PyPI con pip install apistar==0.5.41 . Cualquier desarrollo adicional del servidor API Star probablemente tendría que realizarse en contra de una bifurcación del mismo, bajo un nuevo mantenedor.

Si está buscando un marco asíncrono basado en Python de alto rendimiento, le recomendaría Starlette.

---

API Star es un código con licencia BSD.
Diseñado y construido en Brighton, Inglaterra.