API文档、验证、模拟和客户端。

导航

验证详情

这些详细信息已由PyPI 验证
维护者
Avatar for tomchristie from gravatar.com tomchristie

未经验证的详情

这些详细信息尚未由PyPI验证
项目链接
元数据
  • 许可： BSD许可 (BSD)
  • 作者： Tom Christie
  • 要求： Python >=3.6
分类器

项目描述

API Star

🛠 Web API工具包。 🛠

Build Status codecov Package version

社区： https://discuss.apistar.org 🤔 💭 🤓 💬 😎

文档： https://docs.apistar.com 📘

需求： Python 3.6+

API Star是一个用于处理OpenAPI或Swagger架构的工具包。它允许您

  • 构建API文档，并提供可选的主题。
  • 验证API架构文档，并提供上下文错误。
  • 使用动态客户端库进行API请求。

您可以使用它来构建静态文档，将其集成到Web框架中，或将其用作与其他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 上找到，您可以使用 pip install apistar==0.5.41 从 PyPI 安装。API Star 服务器任何进一步的开发可能需要基于该分支的分支，并由新的维护者进行。

如果您正在寻找一个基于 Python 的高性能异步框架，那么我反而推荐 Starlette。

API Star 是 BSD 许可证下的代码。
在英国布莱顿设计和建造。

API Star

项目详情

验证详情

这些详细信息已由PyPI 验证
维护者
Avatar for tomchristie from gravatar.com tomchristie

未经验证的详情

这些详细信息尚未由PyPI验证
项目链接
元数据
  • 许可： BSD许可 (BSD)
  • 作者： Tom Christie
  • 要求： Python >=3.6
分类器

发布历史 发布通知 | RSS 源

本版本

0.7.2

0.7.1

0.7.0

0.6.0

0.5.42

0.5.41

0.5.40

0.5.39

0.5.38

0.5.37

0.5.36

0.5.35

0.5.34

0.5.33

0.5.32

0.5.31

0.5.30

0.5.29

0.5.28

0.5.27

0.5.26

0.5.25

0.5.24

0.5.23

0.5.22

0.5.21

0.5.20

0.5.19

0.5.18

0.5.17

0.5.16

0.5.15

0.5.14

0.5.13

0.5.12

0.5.11

0.5.10

0.5.9

0.5.8

0.5.7

0.5.6

0.5.5

0.5.4

0.5.3

0.5.2

0.5.1

0.5.0

0.4.5

0.4.3

0.4.2

0.4.1

0.4.0

0.3.9

0.3.8

0.3.7

0.3.6

0.3.5

0.3.4

0.3.3

0.3.2

0.3.1

0.3.0

0.2.14

0.2.13

0.2.12

0.2.11

0.2.10

0.2.9

0.2.8

0.2.7

0.2.6

0.2.5

0.2.4

0.2.3

0.2.2

0.2.1

0.2.0

0.1.17

0.1.16

0.1.15

0.1.14

0.1.13

0.1.12

0.1.11

0.1.10

0.1.9

0.1.8

0.1.7

0.1.6

0.1.5

0.1.4

0.1.3

0.1.2

0.1.1

0.1.0

下载文件

下载适用于您平台的文件。如果您不确定该选择哪个，请了解更多关于 安装包 的信息。

源分布

apistar-0.7.2.tar.gz (3.3 MB 查看哈希值)

源

由以下支持