Grails3.1.4项目,带有招摇过市的文档 描述
我使用的是Grails3.1.4,使用Swagger Api记录控制器类时遇到问题Grails3.1.4项目,带有招摇过市的文档 描述,grails,swagger,swagger-ui,swagger-2.0,Grails,Swagger,Swagger Ui,Swagger 2.0,我使用的是Grails3.1.4,使用Swagger Api记录控制器类时遇到问题 grails-version提供以下输出: | Grails Version: 3.1.4 | Groovy Version: 2.4.6 | JVM Version: 1.8.0_73 我尝试使用以下来源将Swagger集成到项目中: - - 根据这些消息来源,我必须做以下事情: 1.将依赖项添加到build.gradle: 2.将另一个存储库添加到build.gradle: 3.以以下方式注释我的控制器:
grails-version
提供以下输出:
| Grails Version: 3.1.4
| Groovy Version: 2.4.6
| JVM Version: 1.8.0_73
我尝试使用以下来源将Swagger集成到项目中:-
- 根据这些消息来源,我必须做以下事情: 1.将依赖项添加到
build.gradle
:
2.将另一个存储库添加到build.gradle
:3.以以下方式注释我的控制器: 4.在文件
application.yml
中,我添加了:
5.前面提到的源代码写的是我没有的Config.groovy
,所以我没有写:
6.在不存在的Config.groovy
中,我使用yml语法将相同的文本添加到文件application.yml
:
结果
有效的方法是:
我正在使用bootRun
任务运行Grails应用程序,并浏览到http://localhost:8080/myapproot/myDomainClassX/myFunction
并在我的浏览器中查看字符串“MyDomainClassXController,myFunction(),Doe something”
不起作用的是:
当我浏览到http://localhost:8080/myapproot/api
我发现页面未找到(404)”错误。在这里,我希望看到大摇大摆的注释产生文档的魔力
问题:
我在源代码中提到的Swagger插件的配置中犯了什么错误?如果您在/myapprot/api上获得404,请检查您的UrlMappings.groovy文件 将此默认映射保留在其中:
"/$controller/$action?/$id?(.$format)?"{
constraints {
// apply constraints here
}
}
或者至少允许
get "/api/$action?"(controller: 'api')
这样,您至少可以使用该URL访问swaggy控制器。您看过吗?如果没有,我很想得到你的反馈。
@Api(value = "myValue", description = "this controller does something")
@Path("/myapproot/myDomainClassX")
MyDomainClassXController{
@GET
@Path("/myFunction")
def myFunction(){
render "MyDomainClassXController, myFunction(), did something"
}
}
grails:
mime:
disable:
accept:
header:
userAgents: []
swaggydoc {
contact = "developer@coer.com"
description = "API description"
title = "My Swagger Doc for my awesome project"
apiVersion = "0.2cents"
}
swaggydoc:
contact: "developer@coder.com"
description: "API Description"
title: "My Swagger Doc for my awesome project"
apiVersion: "0.2cents"
"/$controller/$action?/$id?(.$format)?"{
constraints {
// apply constraints here
}
}
get "/api/$action?"(controller: 'api')