API Documentation,Validation,Mocking,and clients.

apistar的Python项目详细描述


API Star

Web API工具包。

Build StatuscodecovPackage version


社区:https://discuss.apistar.org

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

需求: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代码。
设计和建造于英国布莱顿。

API Star

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
IntelliJ中的java默认Maven项目结构不一致   java我希望链接(在帖子和页面上)在一些访问者加载时被自动点击   java如何使用单独的方法隐藏JButton并在新类中调用   java KStream leftJoin KStream具有相同的密钥   java图像在垂直滚动窗格视图端口中消失   java从指定的起始点开始以n的增量填充数组   java JLabel和JTextField不在swing表单中应用   java springboot mongo如果没有映像,请使用现有映像   类似C++映射的java容器   java如何在没有Valgrind错误的情况下调用JNI_CreateJavaVM?   java如何在安卓中运行后台服务   java onPostExecute不运行