prance 0.16.0

安装

prance可从pypi获得，并可通过pip安装：

$ pip install prance

注意，这将安装代码，但必须指定其他子包 解锁各种功能。至少，解析后端必须是 安装。对于cli功能，您需要进一步的依赖。

建议的安装将安装cli、使用icu并安装一个验证 后端：

$ pip install prance[osv,icu,cli]

确保您已安装了icu unicode库， 以及在运行上述命令之前的python dev库。如果没有，请使用 以下命令：

###ubuntu

$ sudo apt-get install libicu-dev
$ sudo apt-get install python3-dev

命令行界面

安装prance之后，cli可用于验证（和解析 规范中的外部参考：

# Validates with resolving
$ prance validate path/to/swagger.yml

# Validates without resolving
$ prance validate --no-resolve path/to/swagger.yml

# Fetch URL, validate and resolve.
$ prance validate http://petstore.swagger.io/v2/swagger.json
Processing "http://petstore.swagger.io/v2/swagger.json"...
 -> Resolving external references.
Validates OK as Swagger/OpenAPI 2.0!

验证不是prance的唯一特征。副作用之一 解析是指从具有引用的规范中，可以创建完全解析的 输出规格。在过去，这是通过 validate 命令的选项来完成的， 但现在有一个特定的命令专门用于此目的：

# Compile spec
$ prance compile path/to/input.yml path/to/output.yml

最后，随着openapi 3.0.0的到来，使用工具 将旧规格转换为新标准。而不是重新发明轮子， prance只提供了一个cli命令，用于将规范传递给 swagger2openapi -a工作 因此，此命令需要Internet连接：

# Convert spec
$ prance convert path/to/swagger.yml path/to/openapi.yml

代码

很可能您有spec文件并希望对其进行分析：

frompranceimportResolvingParserparser=ResolvingParser('path/to/my/swagger.yaml')parser.specification# contains fully resolved specs as a dict

prance还包括一个不遵循json的非解析解析器。 推荐信，以备不时之需。

frompranceimportBaseParserparser=BaseParser('path/to/my/swagger.yaml')parser.specification# contains specs as a dict still containing JSON references

在windows上，如果您传递类似posix的路径，代码将正确响应 （ /c:/swagger ）或路径是否相对。如果你通过绝对 windows路径（如 c:\ swagger.yaml ），您可以使用 prance.util.fs.abspath 转换它们。

URL也可以解析：

parser=ResolvingParser('http://petstore.swagger.io/v2/swagger.json')

基本上，就是这样。有很多实用程序代码 或者可能也没用。有关详细信息，请参阅完整的文档。

兼容性

不同的验证后端支持不同的功能。

$ pip install prance

$ pip install prance