API Documentation,Validation,Mocking,and clients.
apistar的Python项目详细描述
Web API工具包。
社区:https://discuss.apistar.org
需求:python 3.6+
api star是一个使用openapi或swagger模式的工具包。它允许您:
- 构建api文档,并选择可用的主题。
- 验证api架构文档,并提供上下文错误。
- 使用动态客户端库发出api请求。
您可以使用它来构建静态文档,将其集成到web框架中, 或者将其用作与其他api交互的客户端库。
快速启动
安装API星形:
$ pip3 install apistar
让我们看看工具包提供的一些功能…
我们将从创建openapi模式开始,schema.yaml
:
openapi:3.0.0info:title:Widget APIversion:'1.0'description:An example API for widgetsservers:-url:https://www.example.org/paths:/widgets:get:summary:List all the widgets.operationId:listWidgetsparameters:-in:queryname:searchdescription:Filter widgets by this search term.schema:type:string
我们还要创建一个配置文件apistar.yml
:
schema:path:schema.yamlformat: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之星项目将作为 与框架无关的api工具套件。计划是把这个 使其适合用作独立的 工具,或与大量框架一起使用。
github上的0.5分支仍然可用,可以从pypi安装
用pip install apistar==0.5.41
。api之星的进一步发展
服务器可能需要在一个新的维护者的领导下,对抗其中的一个分支。
如果您正在寻找一个基于python的高性能异步框架,那么 相反,我推荐Starlette。
api之星是BSD licensed代码。
设计和建造于英国布莱顿。