从Cornice应用程序生成swagger
项目描述
Cornice Swagger
Cornice扩展,用于生成OpenAPI/Swagger规范
Cornice Swagger 从 Cornice 应用程序生成一个符合 OpenAPI/Swagger 2.0 的规范,最大化提取功能代码中的文档数据,同时允许用户覆盖生成的文档的部分内容。
变更
1.0.1 (2021-08-30)
从缺失的属性中获取默认值(感谢 @sp-schoen)
1.0.0 (2020-03-31)
破坏性更改
停止对 Python 2 的支持
内部更改
将 swagger-ui 文件升级到 3.23.11
0.7.0 (2018-07-29)
支持在 colander SchemaNode 自定义 kwarg 上使用 swagger example 字段
def SomeSchema(colander.MappingSchema): name = colander.SchemaNode(colander.String(), example='Mr. IceCream')
相应地在 swagger 规范中返回 example 字段。
0.6.0 (2018-03-28)
添加 cornice_enable_openapi_view() 和 cornice_enable_openapi_explorer() Pyramid 指令以提供 API 探索器和规范信息 (#79)
0.5.5 (2018-03-19)
防止非 colander 架构导致失败 (#78,感谢 @ergo!)
0.5.4 (2018-02-26)
内部
修复文档字符串中的返回类型 (#77)
0.5.3 (2018-02-14)
Pyramid 兼容性
处理 cornice.service.Service.content_type 参数的可调用对象。更多详细信息,请参阅:http://cornice.readthedocs.io/en/latest/api.html#cornice.service.Service。
0.5.2 (2017-11-07)
内部
向 Python 包添加分类器。
0.5.1 (2017-04-10)
Pyramid 兼容性
在解析路径时支持子路径和正则表达式 (#68)。
API
_extract_path_from_service 现在返回路径名称以及路径 swagger 对象 (#68)。
0.5.0 (2017-02-14)
API
允许通过从 CorniceSwagger 类派生来自定义生成器 (#63)。
引入了新的方法 CorniceSwagger.generate 以生成规范 (#63)。
弃用了 CorniceSwagger 调用方法。您现在应使用 generate (#63)。
移除了弃用的 generate_swagger_spec 调用。 (#64)。
允许在 CorniceSwagger 类上定义自定义类型转换器 (#65)。
内部
修复了 PR 上的 coveralls 重复消息 (#62)。
0.4.0 (2017-01-25)
API
默认情况下不包含文档字符串的摘要。您可以通过将 summary_docstrings = True 传递给生成器来启用它们。
尝试在相同的方法上记录多个视图现在会引发异常。您应该通过内容类型忽略不想要的视图。
现在递归地将原始 swagger 项目与提取的字段合并(而不是替换)。
通过在视图上添加 operation_id 参数或在生成器上传递一个 default_op_ids 可调用对象来支持通过 operation_id 记录操作 ID。
在 cornice_swagger.CorniceSwagger 上添加了一个生成器的快捷方式。
支持 Cornice 架构同义词(标题和 GET 与 header 和查询字符串相同)。
通过在视图上添加 api_security 列表或在生成器上传递一个 default_security 列表或可调用对象来支持通过 api_security 记录安全属性。
OpenAPI 兼容性
从响应头和请求参数中删除无效的 title 字段。
支持参数验证器的转换。
内部
修复默认标签生成器。
修复使用声明式架构时的引用。
通过适当隔离 body 来简化参数转换器。
0.3.0 (2017-01-17)
API
使用 cornice_swagger.swagger.CorniceSwagger 类而不是 generate_swagger_spec 生成 swagger 文档。
允许在应用程序中覆盖提取器。
只有在指定的情况下,架构才会被分解为 JSON 指针。
允许通过 response_schemas 视图属性记录响应。
允许通过 tags 视图属性或使用在调用生成器时传递的 default_tags 参数来记录标签。
内部
将转换器与路径生成器解耦。
对包组织进行大量修改。
测试覆盖率达到100%。
文档
创建一个托管在https://cornices.github.io/cornice.ext.swagger上的Sphinx文档。
0.2.1 (2016-12-10)
检查模式是否未被实例化。
添加对查询参数描述的支持。[ridha]
0.2 (2016-11-08)
PyPI发布。
将脚手架文档指向正确的URL。
0.1 (2016-11-05)
新cornice 2.0的第一个版本。
项目详情
下载文件
下载适用于您平台文件。如果您不确定选择哪一个,了解更多关于安装包的信息。
源分布
构建分布
cornice_swagger-1.0.1.tar.gz的散列
算法 | 散列摘要 | |
---|---|---|
SHA256 | 98a63c139af8297e8494ffa4e9f3fe8226a55b8850abb3b65ca555b25105fc34 |
|
MD5 | 32c260c0fe2e1915a3a48e802062b781 |
|
BLAKE2b-256 | 6f07e55351195b4f7700c5c5eb22491c15a4c05b21cc3cd40ea7683a18ef3a9c |
cornice_swagger-1.0.1-py3-none-any.whl的散列
算法 | 散列摘要 | |
---|---|---|
SHA256 | 94baebb818eb79a458497b3b924aacf340af85057abfdba7faa81e20c4d59b84 |
|
MD5 | ec3eb6ff67d7e354b24956a2e7f8c97a |
|
BLAKE2b-256 | 418ff6aaa20e5352ff2fe6a16678280b79688461a05fd88884b1216ab0726769 |