我正在尝试将swagger与我的项目结合起来。
我已经在pom中给出了依赖项,将dist文件夹从swagger复制到我的工作区中。
<repositories>
<repository>
<id>oss-jfrog-artifactory</id>
<name>oss-jfrog-artifactory-releases</name>
<url>http://oss.jfrog.org/artifactory/oss-release-local</url>
</repository>
</repositories>
<dependency>
<groupId>com.mangofactory</groupId>
<artifactId>swagger-springmvc</artifactId>
<version>0.8.8</version>
</dependency>
<dependency>
<groupId>org.ajar</groupId>
<artifactId>swagger-spring-mvc-ui</artifactId>
<version>0.1</version>
<scope>compile</scope>
</dependency>
我还没有创建swagger配置类,但在应用程序上下文中添加了这些。
<mvc:default-servlet-handler/>
<context:annotation-config />
<mvc:annotation-driven/>
<bean name="springSwaggerConfig" class="com.mangofactory.swagger.configuration.SpringSwaggerConfig" />
<bean id="swaggerSpringMvcPlugin" class="com.mangofactory.swagger.plugin.SwaggerSpringMvcPlugin">
<constructor-arg ref="springSwaggerConfig"></constructor-arg>
</bean>
我的API接受一个路径变量并给我响应。这是示例API
@ApiOperation(value="This is the test API")
@RequestMapping(value = "sayHello/{userName}", method = RequestMethod.GET)
public @ResponseBody String testAPI(@ApiParam(defaultValue="xyz", required=true) @PathVariable String userName){
return "Hello" + userName;
}
即使我已经给出了一个默认值,它也没有取值,而是将值作为(空)。
尝试在swagger上检查请求和响应时,没有针对值的输入框,也没有“试用”按钮。
你能让我知道需要做什么来解决这个问题吗?!
您不能在SpringMVC中为PathVariable设置默认值,因为没有办法区分具有空路径变量的请求和具有默认值的请求,因此映射不会匹配。
对于缺少的输入字段,您应该在注释中设置以下属性
@ApiParam(required=true, paramType = "path") @PathVariable String userName