.. image:: https://github.com/Yelp/bravado-core/workflows/build/badge.svg?branch=master :target: https://github.com/Yelp/bravado-core/actions?query=workflow%3Abuild

.. image:: https://img.shields.io/coveralls/Yelp/bravado-core.svg :target: https://coveralls.io/r/Yelp/bravado-core

.. image:: https://img.shields.io/pypi/v/bravado-core.svg :target: https://pypi.python.org/pypi/bravado-core/ :alt: PyPi 版本

.. image:: https://img.shields.io/pypi/pyversions/bravado_core.svg :target: https://pypi.python.org/pypi/bravado-core/ :alt: 支持的 Python 版本

bravado-core

关于

bravado-core 是一个 Python 库，为 OpenAPI 规范 v2.0 <https://github.com/OAI/OpenAPI-Specification>__ 提供客户端和服务器端支持。

特性

• OpenAPI 规范架构验证
• 请求和响应的序列化、转换和验证
• 模型可以是 Python 类或字典
• 自定义格式用于类型转换

文档

文档可在 readthedocs.org <http://bravado-core.readthedocs.org>__ 查看

安装

::

$ pip install bravado-core

相关项目

• bravado <https://github.com/Yelp/bravado>__
• pyramid-swagger <https://github.com/striglia/pyramid_swagger>__
• swagger-spec-validator <https://github.com/Yelp/swagger_spec_validator>__

开发

| 代码使用 Sphinx <http://sphinx-doc.org/>__ 进行文档编写。 | 推荐使用 virtualenv <http://virtualenv.readthedocs.org/en/latest/virtualenv.html>__ 来隔离依赖和库。 | 使用 tox <https://tox.readthedocs.org/en/latest/>__ 进行标准化测试。

设置

::

# 运行测试
tox

# 安装 git pre-commit 钩子
.tox/py310/bin/pre-commit install

贡献

1. Fork 项目 ( http://github.com/Yelp/bravado-core/fork )
2. 创建特性分支 (git checkout -b my-new-feature)
3. 添加修改
4. 在 CHANGELOG.rst 中添加修改的简短摘要
5. 提交更改 (git commit -m "Add some feature")
6. 推送到分支 (git push origin my-new-feature)
7. 创建新的 Pull Request

许可证

| Copyright (c) 2013, Digium, Inc. 保留所有权利。 | Copyright (c) 2014-2015, Yelp, Inc. 保留所有权利。

Bravado 使用 BSD 3-Clause 许可证 <http://opensource.org/licenses/BSD-3-Clause>__ 授权。