Swagger UI 3.9.0 发布,API 在线文档生成利器

来源: 投稿
作者: 王练
2018-01-07

Swagger UI 3.9.0 已发布,这是一款 API 在线文档生成和调试工具。

该版本包含核心插件 API 更改,以及一些突破性变化,包括:

  • Introduced a breaking function signature change to errActions.newThrownErr action creator (from (err, action) to (err)) and err_new_thrown_err action payload (stopped nesting error content under error key in payload, now the error is the payload).

  • 特性:added error catcher for statePlugin interfaces; prevents errors in plugin code from crashing entire application instance (via #4067)

    • The only downside to this is that some errors are now a bit harder to trace! Set a breakpoint at console.error and walk down the stack to see what's going wrong.

  • 特性:display error content when definition/config load fails (via #4069)

  • 特性:display parameter enums, defaults, and examples when not in Try-It-Out mode (via #3977)

  • 改进:added hasOwnProperty checks to a handful of for...in loops (via #4043)

  • 改进:now using nginx location to set Docker base url instead of moving things around the filesystem (via #4073)

  • 改进:brought parameter model property description styling in line with styling for.... everything else (via #4075)

  • 修复:check for Promise on global/window object, which makes IE11 a very happy browser (via #4077)

  • Housekeeping: used zopflipng to compress PNG assets in repo (via #4037)

  • Housekeeping: added maintainer documentation for PR merging workflow (via #4076)

下载地址:

展开阅读全文
24 收藏
分享
加载中
精彩评论
如果可以不通过代码来生成API文档,直接来个可视化界面做文档就好多了。
2018-01-07 13:07
2
举报
通过注解的方式生成API,侵入性太强了,通过编辑器编写YML文件更痛苦,求推荐更人性化的API文档生成器。
2018-01-07 22:51
1
举报
最新评论 (6)

引用来自“MrXionGe”的评论

如果可以不通过代码来生成API文档,直接来个可视化界面做文档就好多了。

引用来自“Carvendy”的评论

不写注解也可以生成,确定好扫描包路径就可以了.

引用来自“Kvein”的评论

扫描路径怎么确定?
Docket(DocumentationType.SWAGGER_2).groupName(properties.getGroupName())        .apiInfo(specialApiInfo()).select().apis(RequestHandlerSelectors.basePackage(properties.getBasePackage()))
        .apis(RequestHandlerSelectors.withClassAnnotation(RestController.class)).build();
但是呢,还是加个点注解好,基本接口功能性描述还是要的.
2018-01-10 08:53
0
回复
举报

引用来自“MrXionGe”的评论

如果可以不通过代码来生成API文档,直接来个可视化界面做文档就好多了。

引用来自“Carvendy”的评论

不写注解也可以生成,确定好扫描包路径就可以了.
扫描路径怎么确定?
2018-01-09 15:44
0
回复
举报

引用来自“MrXionGe”的评论

如果可以不通过代码来生成API文档,直接来个可视化界面做文档就好多了。
不写注解也可以生成,确定好扫描包路径就可以了.
2018-01-08 09:15
0
回复
举报
通过注解的方式生成API,侵入性太强了,通过编辑器编写YML文件更痛苦,求推荐更人性化的API文档生成器。
2018-01-07 22:51
1
回复
举报
这货和springfox有什么关系?
2018-01-07 22:18
0
回复
举报
如果可以不通过代码来生成API文档,直接来个可视化界面做文档就好多了。
2018-01-07 13:07
2
回复
举报
更多评论
6 评论
24 收藏
分享
返回顶部
顶部