我正在尝试使用Swagger UI的API文档,这是使用Sping Boot 框架开发的。
1)pom中的依赖项
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>${springfox-version}</version>
</dependency>
<dependency>
<groupId>io.swagger</groupId>
<artifactId>swagger-core</artifactId>
<version>${swagger-core-version}</version>
</dependency>
<properties>
<springfox-version>2.5.0</springfox-version>
<swagger-core-version>1.5.10</swagger-core-version>
</properties>
2)文档配置
@ComponentScan(basePackages = {"com.testApp.*"})
@Configuration
@EnableSwagger2
public class Application {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.select().apis(
RequestHandlerSelectors.any())
.paths(PathSelectors.any())
.build();
}
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
3)com.testApp包中的资源配置
@Path("/resources")
@Api(value = "Test resource", produces = "application/json")
public class MyResource {
@Autowired
public SomeClass someclass;
/**
*
* @param uriInfo
* @return
* @throws PlatformException
*/
@ApiOperation(value = "Gets a hello resource. World Version 1 (version in Accept Header)", response = String.class)
@ApiResponses(value = {
@ApiResponse(code = 200, message = "Hello resource found"),
@ApiResponse(code = 404, message = "Hello resource not found")
})
@GET
@Produces({ MediaType.APPLICATION_JSON })
public String loadResouces(@Context UriInfo uriInfo) {
//method defination
}
这个服务运行在端口9001上。每当点击localhost:8080/swagger-ui.html时。它返回一个swagger-ui的空页面。我已经尝试了一些Docket的属性,如host,pathmapping等。但我无法使用此属性生成文档。
2条答案
按热度按时间sr4lhrrt1#
据我所知,
springfox-swagger2
仅支持使用Spring MVC
实现的API。如果您更喜欢使用
JAX-RS
实现端点,但仍然使用Swagger
来记录它们,请查看此答案。可以在我以前创建的博客Microservices using Spring Boot, Jersey Swagger and Docker中找到“how-to”
kq0g1dla2#
我已经通过实现TypeResolver和RequestMappingHandlerMapping bean解决了类似的问题。请尝试将以下bean添加到您的应用程序类中。