如何让Swagger在html中生成文档？

文章/答案/技术大牛

发布

1回答

swagger、swagger-2.0、swagger-codegen

我已经使用swagger编写了一个restful API。当我运行我的服务器时，它在X/上正确地提供API，但它也应该在X/ API -docs上提供api的文档。它确实是这样做的，但是它用JSON而不是HTML来表示文档！我翻阅了大量的文档，试图弄清楚如何获得HTML格式的文档，但我搞不懂。

浏览 11提问于2017-03-03得票数 1

回答已采纳

1回答

使用Swagger2.x通过Maven生成HTML文档

java、maven、swagger、swagger-ui

我正在考虑在我的几个不同的项目中生成一些API文档，希望使用Swagger。由于从未使用过Swagger，我正试图找到一个通过Maven生成HTML文档的非常简单的解决方案。我从中找到了文档，但是它似乎没有任何简单地生成HTML的例子。他们的大多数示例似乎将API文档嵌入到实际服务本身中。如何通过Maven使用Swagger生成HTML<e

浏览 0提问于2019-02-19得票数 4

2回答

我可以从已有的Java代码中获得Swagger文档吗？

java、rest、swagger、swagger-ui、swagger-2.0

我是Swagger的新手，我有以下疑问：存在一种自动完成的方法吗？从我的Java代码到Swagger yaml文件？例如，以某种可以被某些工具解析的方式记录我的Java代码？

浏览 12提问于2017-01-13得票数 2

1回答

使用springfox、swagger和gradle生成静态文档

spring、spring-boot、swagger、springfox

我已经在一个简单的Spring Boot应用程序中评估了springfox的集成，它公开了几个REST API。乍一看一切都很好-当应用程序启动时，我可以在JSON端点看到Swagger规范，我可以连接并使用Swagger UI，Swagger注释被考虑在内，我可以使用代码生成静态HTML文档，等等。我现在想知道的是一件非常简单的事情:如何在构建过程中生成静态文档？我使用gradle。在构建过程中，

浏览 1提问于2017-05-18得票数 1

2回答

如何为springdoc swagger-ui HTML页面配置自定义URL？

spring、springdoc、springdoc-openapi-ui

因为springdoc文档取代了以前的Swagger文档，所以我希望在相同的URL localhost:8080/docs/index.html中提供它。根据springdoc文档，我认为可以在application.properties中使用application.properties选项来完成但是，如果我

浏览 3提问于2021-07-21得票数 2

1回答

如何将Swagger OpenAPI规范添加到spring引导项目中？

rest、swagger、swagger-ui、openapi

我找到了这个项目，因为我知道我们可以用.json/.yml文件编写文档。另外，我可以在中看到它可以被呈现到.html文件中。我的问题是-如何从.html文件生成静态.json/.yml页面？我应该以某种方式将.json/.yml文件设置为swagger配置，并获得带有文档的.html文件吗？

浏览 4提问于2016-11-14得票数 4

回答已采纳

2回答

使用maven插件的脱机swagger文档

java、maven、swagger、swagger-maven-plugin

我正在尝试生成swagger文档，为此我需要启动服务器。我想离线生成swagger文档(不用启动服务器)，我只是得到了这个链接但是当我把上面的插件添加到POM.xml (假设在maven构建过程中生成HTML )时，它什么也没做。请帮帮忙。

浏览 15提问于2015-06-04得票数 4

1回答

如何使Swagger在生成的HTML中放置新行(在Swagger页面中)？

java、spring-boot、rest、swagger、swagger-ui

我有一个用io.swagger.annotations.ApiOperation注释的REST服务方法我需要some string在HTML页面swagger-ui.html中生成新行。(也就是说，在Swagger页面中，我可以看到我的文档，并且可以测试我的API方法)。我看到这个项目使用Swagger1.5.20罐。那

浏览 4提问于2020-05-14得票数 2

回答已采纳

1回答

傲慢的用户界面(或其他什么)能公开网页吗？

swagger、swagger-ui

而且，正如所说的，.net的swagger UI的来源是可用的。所以可以通过修改代码来完成。但不知道为什么别人没有这样的要求？

浏览 3提问于2022-07-31得票数 0

3回答

如何使用swagger-jaxrs-doclet的输出生成swagger文档？

java、maven、swagger

Swagger似乎是一个生成REST文档的很酷的工具。但是，我不喜欢它是非常侵入性的，并且需要我在我的java类上添加注释。我发现了一个名为的maven插件，它似乎生成了这些json文件，我应该能够将这些json文件传递到swagger中以生成swagger文档。优点是我不需要在我的任何类上放置swagger注释。不幸的是，swagger-jaxrs-doclet文档没有告诉我下一步要做什么。谁能告诉我如何获取<em

浏览 0提问于2013-08-09得票数 2

1回答

使用Swashbuckle将文本部分添加到Swagger

c#、asp.net-core、swagger、swashbuckle、redoc

在顶部有一组节(例如：)带有一些自定义的html。我想在我的API中生成类似的部分，但是我看不出如何实现。.);后来： c.SpecUrl = "/swagger/v1/swagger.json";}如何将HTML部分添加到基于Swashbuckle.AspNetCore

浏览 1提问于2019-01-22得票数 2

6回答

如何生成离线Swagger文档？

java、spring-mvc、spring-boot、swagger、springfox

我已经能够集成Springfox的API文档。当服务器启动和运行时，我可以直观地看到所有的API。如何生成离线的swagger文档？注意:我不想使用asciidoc或标记文档，但我想在html文件中使用相同的swagger用户界面。我希望链接是相对于本地目录而不是本地主机服务器链接。谢谢

浏览 10提问于2016-01-25得票数 17

回答已采纳

1回答

如何使用swagger生成静态HTML文档？

javascript、sdk、swagger

我有一个集成了Swagger的RESTful API，所以现在可以使用浏览器指向该服务器，并查看用于该API的Swagger文档。我想使用swagger-js项目从服务器上的Swagger数据中生成Javascript中的客户端SDK。它似乎可以生成这个客户端SDK，我可以在工具中按对象和函数探索SDK对象。但是，我想以某种方式为这个客户端SDK生成文档，这样用户就可以阅读它来查找他们想要的调用，而不必在他们的浏览器开发环境中费力地探索。(petId

浏览 0提问于2015-09-21得票数 1

回答已采纳

1回答

为什么Swagger工具会产生不同的服务器存根？

maven、jersey-2.0、swagger-codegen

我想从一个swagger规范文件中生成jersey 2.0服务器存根。当使用Swagger工具生成服务器存根时，我得到了一个包含impl目录的漂亮的泽西服务器存根，其中明确指出了我应该将业务逻辑放在哪里。一切都很好地编译和运行。但是，当我试图使用jersey 2.0生成swagger-codegen-maven-plugin服务器存根时，我无法获得类似的内容。这是我在pom.xml文件中使用的插件配置： <groupId>io.s

浏览 9提问于2022-08-28得票数 0

2回答

如何使Swagger与Swashbuckle一起使用端口443？

swagger、swashbuckle

在我们运行RESTful web服务的QA和Prod环境中，端口80是不打开的。File: swagger-ui-min-js, Line: 10, Column: 4300因此，我一直在挖掘更多的东西，已经走得更远了一点，但仍然没有达到我想要的程度。如果我查看Swagger index.html文件上的源代码，就会发现问题所在： rootUrl: 'http://qa-server:80所以，现在我想我

浏览 2提问于2016-04-14得票数 6

回答已采纳

1回答

将对象转换为多查询参数Swagger

java、spring-boot、swagger、springdoc-openapi-ui

我正在尝试从一个对象生成带有查询参数的swagger文档，但我不确定springdoc是否可能。我知道这在io.springfox中是可能的。我想要的是创建一个单独的对象，将所有字段添加到这个对象中，然后将这些字段作为单独的查询参数显示在swagger文档中。例如测试用例：用于下列代码：在这两种情况下，服务按照预期的方式使用查询参数。我想让测试用例2中的

浏览 6提问于2022-10-20得票数 0

回答已采纳

1回答

如何实现一个返回多个响应类型的Spring控制器？(多个200个代码响应)

spring、spring-boot、spring-mvc、openapi

我有OpenAPI 3文档，它定义了一个方法： get: - Layout - $ref: '#/components/schemas/Item2' 我如何实现Spring控制器来处理这个文档</

浏览 2提问于2022-03-04得票数 0

1回答

用于node.js应用程序的JHipster REST客户端

node.js、rest、jhipster

有没有一种方法可以从现有的jhipster应用程序中生成一个rest-jhipster客户端？而不是手动创建函数和调用？目前正在为此使用。谢谢!

浏览 1提问于2016-10-14得票数 1

回答已采纳

1回答

如何在不使用confluence插件的情况下将swagger/openapi yaml文件包含到doctoolchain中并获得类似swagger的输出？

openapi、asciidoc、doctoolchain

我曾尝试使用https://doctoolchain.github.io/docToolchain/创建包含swagger/openapi yaml文件的HTML或PDF文档。它看起来唯一的输出是成合流，这也需要一个额外的合流插件。这是目前唯一的选择吗？我可以使用docToolchain做其他的asciidoc和图表格式化，我会很高兴包括swagger。我可以发布到confluence，但不能将任何一个swagger插件添加到我们的系统中

浏览 79提问于2021-08-04得票数 3

3回答

是否可以使用flask-RESTplus自动生成swagger元数据json？

python、json、swagger、swashbuckle、flask-restplus

我已经使用python库flask-Restplus创建了一个api，并将其关联的swagger ui暴露给例如。有没有可能以某种方式将这个文档页面公开为json？我知道使用.Net库"Swashbuckle“可以做到这一点(例如，将以json格式返回文档)。我正在寻找一种在python中实现同样类型的功能的方法。

浏览 13提问于2018-02-05得票数 0

回答已采纳

点击加载更多