Swagger.io - API 文档生成器

Posted

技术标签:

【中文标题】Swagger.io - API 文档生成器【英文标题】:Swagger.io - API docs generator 【发布时间】:2015-06-04 10:45:59 【问题描述】:

我想将 Swagger.io 用于我的 API 文档。 问题是他们的文档,委婉地说,很烂。

我正在使用他们的编辑器:http://editor.swagger.io 并希望下载与此页面上所见完全一致的输出结果(包括 html 模板)。

以前有人做过吗?我就是无法下载正常运行的东西。

【问题讨论】:

【参考方案1】:

您可以在 Swagger Editor 中放置一个非常简单的 CSS,使其仅显示文档。这是一个 hack,但如果你真的想这样做,这是一种方法

 .main-header, .editor.pane, .ui-splitbar 
     display: none;
 

 .preview.pane 
     left: 0 !important;
     top: 0 !important;
     right: 0 !important;
     width: 100% !important;
 

【讨论】:

以上是关于Swagger.io - API 文档生成器的主要内容,如果未能解决你的问题,请参考以下文章

Spring集成Swagger,Java自动生成Api文档

API接口文档利器:Swagger

SpringBoot整合Swagger2

运用swagger编写api文档

Swagger接口测试框架-知识集锦

swagger暴露程序接口文档