apistar

? Набор инструментов веб-API. ?

---

Сообщество: https://discuss.apistar.org? ? ? ?

Документация: https://docs.apistar.com.

Требования: Python 3.6+.

---

API Star — это набор инструментов для работы со схемами OpenAPI или Swagger. Это позволяет вам:

• Создайте документацию по API с выбором доступных тем.
• Проверка документов схемы API и предоставление контекстных ошибок.
• Делайте запросы API, используя динамическую клиентскую библиотеку.

Вы можете использовать его для создания статической документации, интеграции ее в веб-инфраструктуру или использования в качестве клиентской библиотеки для взаимодействия с другими 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 и может быть установлена ​​из PyPI с помощью pip install apistar==0.5.41 . Любая дальнейшая разработка сервера API Star, скорее всего, будет осуществляться против его форка под руководством нового сопровождающего.

Если вы ищете высокопроизводительную асинхронную среду на основе Python, я бы рекомендовал Starlette.

---

API Star — это лицензионный код BSD.
Спроектирован и построен в Брайтоне, Англия.