从檐口应用程序生成招摇
cornice-swagger的Python项目详细描述
飞檐招摇
cornice扩展以生成openapi/swagger规范
飞檐招摇过市 OpenAPI/Swagger 2.0 compliant specification 来自Cornice应用程序 从功能代码中最大化提取的文档数据, 同时允许用户重写生成的文档的某些部分。
更改
0.7.0(2018-07-29)
在colander上支持swaggerexample字段SchemaNode自定义Kwarg:
def SomeSchema(colander.MappingSchema): name = colander.SchemaNode(colander.String(), example='Mr. IceCream')
相应地,example字段在swagger规范中返回。
0.6.0(2018-03-28)
- 添加cornice_enable_openapi_view()cornice_enable_openapi_explorer() 提供API资源管理器和规范信息的金字塔指令(79)
0.5.5(2018-03-19)
- 使用非colander模式防止失败(78,谢谢@ergo!)
0.5.4(2018-02-26)
内部构件
- 修复docstrings(77)中的返回类型
0.5.3(2018-02-14)
金字塔遵从性
- 处理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)
金字塔遵从性
- 解析路径时支持子路径和正则表达式(68)。
api
- _extract_path_from_service,现在返回路径名和路径 招摇的物体(68)。
0.5.0(2017-02-14)
api
- 允许通过子类化CorniceSwagger类(63)实现自定义生成器。
- 引入了一个新方法CorniceSwagger.generate来生成规范(63)。
- 已弃用CorniceSwagger调用方法。现在应该使用generate(63)。
- 已删除不推荐的generate_swagger_spec调用。(64)。
- 允许在CorniceSwagger类上定义自定义类型转换器。(65)
内部构件
- 固定工作服重复的信息在减贫战略。(62)。
0.4.0(2017-01-25)
api
- 默认情况下,现在不包括docstring中的摘要。你可以让他们通过 summary_docstrings = True发送到生成器。
- 尝试在同一方法上记录多个视图现在会引发异常。你应该 按内容类型忽略不需要的内容。
- 原始swagger项现在递归地合并(而不是替换)为 提取的字段。
- 通过视图上的operation_id参数添加对记录操作id的支持 或者通过将可调用的default_op_ids传递给生成器。
- 在cornice_swagger.CorniceSwagger上添加生成器的快捷方式。
- 支持Cornice模式同义词(headers和get与header和querystring相同)。
- 通过视图上的api_security列表添加对记录安全属性的支持 或者通过向生成器传递default_security列表或可调用。
openapi符合性
- 从响应头和请求参数中删除无效的title字段。
- 支持参数验证器的转换。
内部构件
- 修复默认标记生成器。
- 修复使用声明性架构时的引用。
- 通过适当隔离body,简化参数转换器。
0.3.0(2017-01-17)
api
- 使用cornice_swagger.swagger.CorniceSwagger类生成 而不是generate_swagger_spec。
- 允许重写应用程序中的提取器。
- 只有在指定的情况下,模式才会被分解为json指针。
- 允许通过response_schemasview属性记录响应。
- 允许通过tagsview属性或使用 default_tags调用生成器时的参数。
内部构件
- 将转换器与路径生成器分离。
- 在包装组织上做相当大的改变。
- 测试覆盖率达到100%。
文档
0.2.1(2016-12-10)
- 检查架构是否未实例化。
- 添加对查询参数描述的支持。[瑞达]
0.2(2016-11-08)
- PYPI释放。
- 将scaffold doc指向右url。
0.1(2016-11-05)
- 新Cornice 2.0的首次发布