我正在尝试为Rest集成Swagger，它由Play Framework2.5.x提供服务。
我做了以下工作：
在我的build.sbt中包含了以下依赖项
"io.swagger“%% "swagger-play2”% "1.5.3“"org.webjars”%“webjars”-play“% "2.5.0-4”org.webjars“% "swagger-ui”% "2.2.0“
在我的路线上增加了以下内容：
获取controllers.Assets.at(path="/public/swagg
浏览 0提问于2018-02-25得票数 2
回答已采纳
大多数已有的为Play Framework (Scala)自动生成swagger文档的项目都在使用传统的routes文件，即https://github.com/iheartradio/play-swagger。 您是否注意到使用Play Scala Sird Router而不是传统的routes文件的类似情况？https://www.playframework.com/documentation/2.8.x/ScalaSirdRouter
浏览 19提问于2020-10-29得票数 1
我刚开始玩框架游戏，我试着理解SimpleRouter类。在剧本文档中，我看到一个简单的例子：
val router = Router.from {
case GET(p"/hello/$to") =>
Action {
Results.Ok(s"Hello $to")
}
}
但我不知道什么是Action，它的意义是什么？我也看到它在所有其他路由方法中大量使用。下面是指向文档的链接：
我的参考代码：
import play.api.mvc._
import play.api.routing.Router._
impo
浏览 4提问于2022-03-01得票数 0
回答已采纳
1回答
我创建了一个SIRD路由器。但这并不能解决我的路线。以下代码中的错误是什么？
包UserRouter.scala中的SIRD路由器文件WSRouters.User
package WSRouters.User
import javax.inject.Inject
import play.api.mvc._
import play.api.routing.Router.Routes
import play.api.routing.SimpleRouter
import play.api.routing.sird._
import controllers.UserController
clas
浏览 0提问于2018-02-19得票数 0
回答已采纳
4回答
我正在尝试使用Swagger来记录Play 2的REST API，但是swagger-play2似乎不理解用Scala的Option类型定义的可选参数--在Play 2中使参数成为可选的正常方法：
GET /documents controllers.DocumentController.getDocuments(q: Option[String])
我希望q参数是可选的。有一个与此Option[String]参数匹配的带注释的控制器方法。在启动时，我在日志中获得了UNKOWN TYPE，api-docs生成的json中断了swagger-ui
UNKNOWN TYPE: scala.Opti
浏览 2提问于2014-02-18得票数 15
问题：
我正在用Java或JavaScript (或者Scala)搜索一个库，它能够生成Swagger、RAML或able输入的HTML表示。
背景：
其想法是将其用作(Play Framework) web应用程序的一部分，用作API目录。API规范将由API目录的用户添加，产生的HTML表示将生成/显示。
如果还可以使用Java创建API规范存根，则会产生额外的价值。API目录web应用程序有一个数据模型，我想在生成API存根时使用它。
此外，如果同一个(或其他相关的)库为API规范语言(Swagger、RAML、API等)提供了一个很好的HTML编辑器来支持用户进行编辑，那么它将带来额外
浏览 3提问于2014-10-24得票数 0
我正在尝试用我的Play-2.5项目配置。
我遵循了这个，它起了作用，但只适用于较旧版本的Play，而不是使用Play-2.5。当该项目迁移到Play-2.5时，我们不得不删除swagger配置。
首先，问题似乎是在玩静态控制器和非静态控制器-2.5，但我最终证明自己错了。我正面临着这个错误
type ApiHelpController is not a member of package controllers
GET /api-docs controllers.ApiHelpController.getResource
浏览 2提问于2016-04-18得票数 6
我正在使用Scala和Play 2.5开发一个微服务，并试图用Swagger记录我的端点。
我将Swagger添加到我的依赖项中：
"org.webjars" % "swagger-ui" % "2.1.8-M1"
以及Swagger Play2插件：
"io.swagger" %% "swagger-play2" % "1.5.3"
注意: Swagger Play2插件的1.5.3版本尚未正式发布。我从项目的主分支构建了它，因为它是唯一可以使用Play 2.5.8的版本，也就是我正在使用的版本。
浏览 3提问于2016-10-25得票数 2
我有一个工作项目，使用Play的编译路由。我想添加SIRD路由来处理一些web服务。编译后的路由将保持不变。
我创建了一个routes.users包，并在其中添加了以下UserRoutes scala类。
package routes.users
import javax.inject.Inject
import play.api.mvc._
import play.api.routing.Router.Routes
import play.api.routing.SimpleRouter
import play.api.routing.sird._
import controllers.Us
浏览 1提问于2018-02-19得票数 0
回答已采纳
我有一个集成了Swagger的RESTful API，所以现在可以使用浏览器指向该服务器，并查看用于该API的Swagger文档。我想使用swagger-js项目从服务器上的Swagger数据中生成Javascript中的客户端SDK。
它似乎可以生成这个客户端SDK，我可以在工具中按对象和函数探索SDK对象。但是，我想以某种方式为这个客户端SDK生成文档，这样用户就可以阅读它来查找他们想要的调用，而不必在他们的浏览器开发环境中费力地探索。
例如，如果我的客户端SDK是从Swagger数据生成的，并且具有以下方法：
PetStore.addPet(petData)
PetStore.updat
浏览 0提问于2015-09-21得票数 1
回答已采纳
我正在从Swagger文档中创建自动类型安全REST (Refit)。我正在手动创建接口和模型类，如下所示。有什么工具可以像这样生成吗？
Swagger文件：
"paths": {
"/configuration/v1/devices/{device_serial}": {
"get": {
"tags": [
"Devices"
],
"summary": "Get variablised template f
浏览 3提问于2021-07-05得票数 0
2回答
我想将从{service}/ Swagger /docs/v1获得的JSON中的swagger数据解析为动态生成的.NET类。
我面临的问题是，不同的API可以有不同数量的参数和操作。如何动态解析不同服务的Swagger JSON数据？
我的最终结果应该是所有API的列表，以及它在一个变量中的操作，我可以在这个变量上轻松地执行搜索。
浏览 0提问于2015-05-06得票数 4
我正在尝试创建API文档。我使用Swagger来做这件事。我添加了以下依赖项：
<!-- swagger -->
<dependency>
<groupId>io.swagger</groupId>
<artifactId>swagger-core</artifactId>
<version>1.6.2</version>
</dependency>
<dependency>
<g
浏览 4提问于2021-02-02得票数 0
我使用的是play-Framework2.7，并遵循本教程
我跟随着所有的步骤
已添加
play.modules.enabled += "play.modules.swagger.SwaggerModule"
在application.conf中，这里是我的build.sbt文件
scalaVersion := "2.12.8"
routesGenerator := InjectedRoutesGenerator
libraryDependencies += guice
libraryDependencies += "org.scalatestplus
浏览 2提问于2019-03-20得票数 2
回答已采纳
2回答
我过去在Java REST API中使用Swagger，它是最好的可用工具。
swagger是否支持为Thrift RPC文件生成文档？
浏览 2提问于2018-12-10得票数 4
Swagger规范文档未作为子项目从Swagger集成到Node.js项目中生成。但是，SwaggerUI已经启动并运行。如果我们提供swagger.json或api-docs.json文件，那么它将呈现指定的REST API calls。我的要求是为现有项目生成API文档。我该怎么做呢？
浏览 0提问于2016-02-18得票数 1
我有一个没有考虑到的REST。它没有swagger.json文件。我不控制这个API。API基于URL，响应GET、POST和PUT请求，并返回JSON或XML。
是否有一条可以让我在这个API中使用swagger-codegen工具的前进道路？也就是说，我知道我通常可以为API生成客户端代码
$ swagger-codegen generate -i http://petstore.swagger.io/v2/swagger.json -l ruby -o /tmp/test/
我想知道的是有没有办法
为API编写我自己的swagger.json文件
做些什么？--将请求和响应转换为
浏览 0提问于2019-02-14得票数 1
在我们运行RESTful web服务的QA和Prod环境中，端口80是不打开的。因此，目前，当我试图进入QA中的Swagger时，我收到了这条消息，它只是挂起：
fetching resource list: http://qa-server:80/product-catalog-api/swagger/docs/v1; Please wait.
我正在使用Swashbuckle配置Swagger。我还在配置中更改了这一行，但仍然无法工作。
// If schemes are not explicitly provided in a Swagger 2.0 document, then the
浏览 2提问于2016-04-14得票数 6
回答已采纳
我有一个由向导创建的asp.net核心web -它生成的代码如下所示：
public static void Main(string[] args)
{
var builder = WebApplication.CreateBuilder(args);
// Add services to the container.
builder.Services.AddAuthorization();
// Learn more about configuring Swag
浏览 7提问于2022-11-28得票数 0
我们使用slim框架和swagger-php动态生成swagger文档。我们现在在API中有了一些不应该公开记录的特殊方法。(/doc现在)我有什么办法可以获得第二个文档url (/doc2)，在那里我可以将秘密方法和params文档化吗？(无需手工编写文档，只需使用php代码中的注释)。谢谢。
浏览 3提问于2016-02-05得票数 0
回答已采纳
我正尝试在我的scala Play 2.2项目中使用swagger，它基于wordnik的swagger-play2。似乎在swagger中处理Joda DateTime有一个问题。使用wordnik示例播放项目，在“Order”case类中，
@ApiModel("Order")
case class Order (
@(ApiModelProperty @field)(position=1)id: Long,
@(ApiModelProperty @field)(position=2)petId: Long,
@(ApiModelProperty @field)
浏览 1提问于2014-01-21得票数 1
有插件，上面写着支持Swagger2.0，但实际上它使用的是，而不是2.0，因此不支持OpenApi3.0。
是否有人使用代码优先接口声明将Api 3与Play Framework连接？
我试图将显式的swagger核心依赖声明为
"io.swagger.core.v3" % "swagger-core" % "2.0.5"
但是没有成功，也就是说，我在初始化插件时出错：
[error] 1) Error injecting constructor, java.lang.NoClassDefFoundError: Could not initia
浏览 0提问于2018-09-24得票数 3
默认情况下，/swagger.json将在以下路由“/ Swagger /{ }/swagger.json”公开。如果有必要，您可以在启用Swagger中间件时对此进行更改。自定义路由必须包括{documentName}参数。
为什么模板配置需要这个占位符，而UI配置不需要？
app.UseSwagger(c =>
{
c.RouteTemplate = "api-docs/{documentName}/swagger.json";
})
NOTE: If you're using the SwaggerUI middleware, you'
浏览 4提问于2020-09-18得票数 8
回答已采纳
我想导入使用swagger gradle插件创建的API定义文件。我有一个spring boot mvc应用程序。我似乎无法获得正确的解析设置来生成openAPI.json。gradle解析任务只创建一个带有"openapi“："3.0.1”标记和值的空文件。resolve任务不会拾取swagger和mvc api注释。您能为我指出正确的方向，以便为swagger gradle resolve任务找到正确的配置设置吗？
当应用程序运行时，应用程序显示Spring-UI文档没有问题，我查看了swagger-ui端点。问题是在gradle构建期间，有一个单独的gradle任务来生成
浏览 2提问于2018-10-19得票数 6
我有一个现有的Spring，我想为它生成OpenAPI 3.0 YAML文件，而不是Swagger2.0JSON/YAML？
因为到目前为止，SpringFox不支持YAML生成。它使用Swagger2.0(遵循OpenAPI3.0规范)生成JSON。
此外，还有，但它似乎不支持Spring。
我尝试了孔晨spring plugin，它能够生成YAML文件，但使用Swagger2.0定义，而不是打开API3.0，如下所示：
swagger: "2.0"
info:
description: "Test rest project"
version:
浏览 0提问于2019-02-28得票数 26
回答已采纳
2回答
我是Swagger的新手，我有以下疑问：
我知道，至少我必须在编写REST之前创建Swagger文档，并使用这个文档来创建我的API (我知道，通过Swagger，我也可以自动生成API服务器)。
我的问题是：
我正在开发一个实现REST的Java应用程序(一个Spring应用程序)。我想使用Swagger来创建我的API文档。
存在一种自动完成的方法吗？从我的Java代码到Swagger yaml文件？例如，以某种可以被某些工具解析的方式记录我的Java代码？
浏览 12提问于2017-01-13得票数 2
Spring REST Docs最近发布了，文档中说：
这种方法可以使您摆脱像Swagger这样的工具所施加的限制。
因此，我想问一下，与Swagger相比，Spring REST文档什么时候更适合使用，以及它能释放哪些限制。
浏览 3提问于2015-12-24得票数 42
回答已采纳
1回答
我关注了https://github.com/swagger-api/swagger-play/blob/master/play-2.7/swagger-play2/README.md，并在我的play 2.7应用程序中集成了swagger-play2 1.7.1版。在访问/swagger.json端点时，我从swagger库抛出了以下错误。 play.api.http.HttpErrorHandlerExceptions$$anon$1: Execution exception[[NullPointerException: null]]
at play.api.http.HttpError
浏览 16提问于2019-06-14得票数 0
回答已采纳
最初，我使用缺省路由方法，在conf目录中指定我的路由。
现在我切换到Play的路由DSL，我的路由器如下所示：
package controllers.app.api
import javax.inject.Inject
import play.api.routing.Router.Routes
import play.api.routing.SimpleRouter
import play.api.routing.sird._
class UserRouter @Inject()(controller: UserController) extends SimpleRouter {
浏览 3提问于2017-04-13得票数 0
1回答
我有问题，当我尝试附加Swagger播放框架应用程序。Swagger lib扫描未初始化类并导致问题。有什么建议要怎么处理吗？
我提取了app的一部分作为示例：
CreationException: Unable to create injector, see the following errors:
1) Error injecting constructor, java.lang.RuntimeException: There is no started application
at auth.services.AuthService.<init>(AuthServi
浏览 0提问于2016-02-23得票数 3
1回答
我正在开发一个带有插件的webapi。当插件被添加时，我想更新swagger文档。当我不使用版本的时候我可以处理这件事。所有方法都添加到swagger文档中。
但是当api打开了api版本时，新版本swagger文档的生成就失败了。它返回404。
我需要做些什么才能使版本控制工作并获得动态控制器函数.
private string AddSwaggerVersionDocument(PluginMetadata metadata)
{
var version = metadata.Version.ToApiVersion();
浏览 1提问于2018-12-13得票数 1
回答已采纳
我试图为一个接受case类对象数组的方法编写swagger。我所做的事情如下：
package models
import io.swagger.annotations.{ApiModel, ApiModelProperty}
import play.api.data.Form
import play.api.data.Forms.{mapping, nonEmptyText, seq}
import play.api.libs.json.{Json, Writes}
import spray.json.DefaultJsonProtocol
object Message extends
浏览 1提问于2019-12-09得票数 0
回答已采纳
1回答
我目前正在评估一个新项目的游戏框架。我在看一些很简单的东西，但我似乎无法让它起作用。我想将计数示例的简单路由器移动到路由DSL上。例如
-> /count controllers.CountRouter
然后是应用程序/控制器dir中的以下生命
package controllers
import javax.inject.Inject
import play.api.routing.Router.Routes
import play.api.routing.SimpleRouter
import play.api.routing.s
浏览 1提问于2018-10-31得票数 0
回答已采纳
我有一个ASP.NET Core应用程序，目标是.NET Core2.1框架。这个应用程序提供一个JSON并返回RESTful数据。
使用交互式的、基于web的SwaggerGen在中，我创建了一个API定义文档，并将它以JSON格式保存为'swagger.json‘在我的ASP.NET Core应用程序项目中的一个文件夹中。
由于我已经定义了API，所以不需要在我的应用程序中运行SwaggerGen。我只想让SwaggerUI显示我创建的静态'swagger.json‘文件。
我读过Swashbuckle文档以及几个“如何开始使用Swashbuckle”教程，但它们
浏览 1提问于2019-07-18得票数 4
回答已采纳
我已经完成了jboss7.2的jersey REST服务的代码。下面是我的休息与昂首阔步。但是我不能为示例rest服务.Can生成swagger文档，有谁能帮我一步一步详细地使用swagger生成rest文档
@Api(value="Employee" ,description="manage Emnployee")
@Path("/employee")
public class TestServices {
@Path("/get/{id}")
@GET
@Produces(MediaType.A
浏览 1提问于2015-07-21得票数 0
我在googled上搜索了一点，以找到一种合适且易于实现的方法，为现有的Rails API应用程序生成文档。简而言之，有两种实现方式:通过控制器、模型或通过Rspec控制器/请求规范。清单不长，作出选择也不那么容易：
宝石，-最古老的优点:实现要在控制器中完成。缺点:不支持Swagger V2版本，仅限于1.2。
gem，改进版本的swagger-docs，支持Swagger V2版本，实现将在控制器、模型中完成。但是我无法使它工作，无法解析生成的json文件。
gem:使用基于Swagger的DSL扩展rspec“请求规范”。就我个人而言，我发现在现有的Rails应用程序中实
浏览 0提问于2018-12-04得票数 6
1回答
我想为我们的服务提供的REST发布REST元数据。在过去的几年中，ASP.Net已经改变了很多次，我现在无法获得任何关于推荐的实践的有用信息。不断出现的名字是Swagger。--我猜这是现在推荐的框架。这是个安全的假设吗？
但是，为了使用Swagger，我们需要使用连接到ASP.NET Core2.0的开源库。似乎Swagger支持并不是内置到ASP.NET Core2.0中的。我认为微软必须有某种标准的REST服务自带文档，但我找不到任何文档。是否有内置于ASP.NET Core2.0中的用于自文档化REST服务的东西？，如果是，是否值得尝试实现它而不是Swagger？或者，Swagger就
浏览 5提问于2018-01-09得票数 2
我已经看过这个Spring REST Docs -
我们正在做Spring boot项目，并使用springfox库来生成Swagger-ui和swagger文档，如所述
我们喜欢Spring Rest文档可以用来生成REST API文档的功能，并且我们不需要在控制器代码中添加@ApiResponse或@ApiOperation这样的夸张注解。还有一个事实是，文档现在与代码共存。
但是如果使用Spring Rest文档，我们将错过为我们的API自动生成的Swagger-UI (当我们使用swagger集成时)。
Spring REST文档可以生成像Swagger UI这样的测试UI吗？
浏览 11提问于2017-03-15得票数 1
2回答
在角度上使用摆动
、、、、
我是Swagger的新手，据我所见，它是用来自动生成API文档的。此外，我认为它也用于生成前端使用Swagger。在这一步中，我对在我的项目中正确地使用swagger感到困惑。
我已经使用.NET核心创建了我的后端，并且已经准备好了。现在，我需要将swagger集成到我的项目中。我有一个初始的角前端应用程序，但是由于代码是混合的，我想从stratch创建前端，然后将Swagger集成到其中。是这样的；
1.应该使用必要的Swagger工具生成前端吗？它似乎不是很好，但如果它是普遍使用，不会成为一个问题，因为项目变得更大，当然，我可以使用这个选项。
2.，如果我从stratch创建了一个角度项目
浏览 5提问于2020-09-25得票数 1
回答已采纳
我正在遵循的步骤
我为API契约编写了Swagger，并为我的Microservice编写了定义模型
现在，我在我的Spring应用程序中使用Swagger依赖项通过从URL读取Swagger生成模型，该URL托管在我的应用程序的目标目录(pom.xml中提到的输出目录)中的"mvn“目录中。
对于Swagger文件中的每个定义，将在我的应用程序的目标目录中生成一个模型类。
现在，我使用mongoDB作为数据库，以便将模型保存为集合。
需要为模型类动态地提供@Document(value = "collection-name&
浏览 3提问于2021-07-30得票数 1
5回答
我继承了一个现有的API，我想用swagger来记录它，但我还不知道它的全部范围。Swagger (或其他中间件/工具)是否可以基于现有的express路由自动生成yaml (用于swagger)？
对于我在其他问题上看到的，这似乎主要是一个手工工作，但我正在仔细检查这里是否有人找到了解决这个问题的方法。
浏览 2提问于2015-07-09得票数 55
下面是pom.xml的相关部分
<plugin>
<groupId>com.google.code.maven-replacer-plugin</groupId>
<artifactId>replacer</artifactId>
<version>1.5.2</version>
<executions>
<execution>
<
浏览 23提问于2015-06-03得票数 2
有没有办法使用spring全局配置swagger，以便swagger可以通过扫描类/方法签名自动推断并生成文档，而不必使用swagger注释注释每个单独的方法？
浏览 0提问于2017-05-13得票数 0
我有一个自命不凡的文档生成的go应用程序。最近，在我的项目中添加了新的端点，在POST & PUT请求中使用以下结构：
Secret struct {
// Secret unique key name.
Name string `json:"name" example:"ACCESS_TOKEN"`
// type: string
// x-go-type: "string"
Value json.RawMessage `json:"value&#
浏览 12提问于2021-12-23得票数 3
回答已采纳
我是的新手，所以我可能把这些细节弄错了。Swagger似乎是一个生成REST文档的很酷的工具。但是，我不喜欢它是非常侵入性的，并且需要我在我的java类上添加注释。我发现了一个名为的maven插件，它似乎生成了这些json文件，我应该能够将这些json文件传递到swagger中以生成swagger文档。优点是我不需要在我的任何类上放置swagger注释。
不幸的是，swagger-jaxrs-doclet文档没有告诉我下一步要做什么。谁能告诉我如何获取swagger-jaxrs-doclet的输出并从中生成swagger文档？我需要在maven中做这件事。
浏览 0提问于2013-08-09得票数 2
1回答
我拥有多个rest服务，这些服务由多个swagger文档描述。
这些服务共享一些常见的DTO类。目前，公共DTO类包含在每个swagger文档的定义中。
我希望从swagger文档生成客户端C#代码，这样就不会多次生成公共类。
浏览 8提问于2017-03-15得票数 1
我正在使用grape开发我的rails api，除了动态模型形式之外，它对所有模型都工作得很好。我们有以下型号..
1- product_type
2- product_fields
3- products
product_type与product_fields和products型号都有has_many关联。在创建新的product_type时，我们可以为该product创建各种字段属性。每个product有不同的属性，但我们将它们存储在sing表"products“中。我想在添加任何product_type时动态生成接口。
我已经尝试了如下所示，但在发布记录时不断收到错误。感谢您的建
浏览 3提问于2015-08-10得票数 0
我看过示例应用程序，我对在play 2应用程序上使用swagger很感兴趣。因此，我在Build.scala中包含了依赖项，就像该项目一样：
val appDependencies: Seq[sbt.ModuleID] = Seq(
"com.wordnik" %% "swagger-play2-utils" % "1.1.1")
val main = PlayProject(appName, appVersion, appDependencies, mainLang = SCALA).settings(
resol
浏览 4提问于2012-11-23得票数 2
回答已采纳
2回答
我正在尝试生成swagger文档，为此我需要启动服务器。我想离线生成swagger文档(不用启动服务器)，我只是得到了这个链接
但是当我把上面的插件添加到POM.xml (假设在maven构建过程中生成HTML )时，它什么也没做。请帮帮忙。
浏览 15提问于2015-06-04得票数 4
我已经开始在一个项目中使用Spring Rest Docs，但公司中的其他API仍在使用Swagger/OpenAPI，这导致了样式不一致。
通常的Swagger视图(例如)为每个url和CSS着色GET/POST/PUT/DELETE等都有可折叠的部分。
我应该能够使用adoc中的一行来自定义asciidoctor
:stylesheet: custom.css
Spring Rest Docs是否有一个模板可以提供类似于默认Swagger输出的输出？
你能把javascript添加到asciidoctor的输出中，来动画化一些文档，比如可折叠的url部分吗？
浏览 4提问于2018-08-15得票数 0
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
对象存储
腾讯会议
实时音视频活动推荐
腾讯云开发者
