apistar

? O kit de ferramentas da API da Web. ?

---

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

Documentação: https://docs.apistar.com

Requisitos: Python 3.6+

---

API Star é um kit de ferramentas para trabalhar com esquemas OpenAPI ou Swagger. Ele permite que você:

• Crie documentação de API, com uma seleção de temas disponíveis.
• Valide documentos de esquema de API e forneça erros contextuais.
• Faça solicitações de API usando a biblioteca de cliente dinâmica.

Você pode usá-lo para construir documentação estática, integrá-la a uma estrutura da Web ou usá-la como biblioteca cliente para interagir com outras APIs.

Início rápido

Instale a API Star:

$ pip3 install apistar

Vamos dar uma olhada em algumas das funcionalidades que o kit de ferramentas oferece...

Começaremos criando um 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

Vamos também criar um arquivo de configuração apistar.yml :

 schema :
  path : schema.yaml
  format : openapi

Agora estamos prontos para começar a usar a ferramenta de linha de comando apistar .

Podemos validar nosso esquema OpenAPI:

 $ apistar validate
✓ Valid OpenAPI schema.

Ou crie documentação de desenvolvedor para nossa API:

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

Também podemos fazer solicitações de API ao servidor referenciado no esquema:

 $ apistar request listWidgets search=cogwheel

Para onde foi o servidor?

A partir da versão 0.6, o projeto API Star está sendo focado como um conjunto de ferramentas de API independente de estrutura. O plano é desenvolver essa funcionalidade de uma forma que a torne apropriada para uso como uma ferramenta independente ou em conjunto com uma grande variedade de estruturas.

A ramificação 0.5 permanece disponível no GitHub e pode ser instalada a partir do PyPI com pip install apistar==0.5.41 . Qualquer desenvolvimento adicional do servidor API Star provavelmente precisaria ser feito em uma bifurcação dele, sob um novo mantenedor.

Se você está procurando uma estrutura assíncrona baseada em Python de alto desempenho, eu recomendaria Starlette.

---

API Star é um código licenciado BSD.
Projetado e construído em Brighton, Inglaterra.