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
}
就我所知,SpringFox-Swagger2
只支持使用Spring MVC
实现的API。
如果您更喜欢使用JAX-RS
实现endpoint,但仍然使用swagger
记录它们,请看一下这个答案。
在我不久前创建的一个博客上可以找到一个“操作方法”,微服务使用Spring Boot、Jersey Swagger和Docker
有没有人用spring-data-rest配置了swagger。我知道swagger有DocumentationConfig类,它扫描所有spring-mvc请求映射。但是,如何将其用于spring-data-rest,因为没有定义显式的请求映射。非常感谢在这方面的任何帮助。此外,我还想知道,是否有其他支持Spring-Data-REST的文档框架。
我们在我们的泽西应用程序中使用了@Role允许注释来限制用户对应用编程接口某些部分的访问。我们如何在SwaggerUI中显示这些信息? 到目前为止,我已经用@ApiOperation注释了方法以显示in/out参数,并尝试使用@Authorization/@AuthorizationScope,但我只为我们不使用的oauth2显示了它。最接近out case的是ApiKeyAuthDefiniti
理想情况下,我们将有一个显示所有标记为public的控制器/方法的大摇大摆的页面,以及另一个显示所有endpoint的密码安全endpoint。这可能吗?
我有一个java项目(tomcat webapp)和一些REST Api。我想为他们生成大摇大摆的文档。我从本教程(github)开始。我没有maven我们使用蚂蚁任务。我加入了swagger-annotations-1.5.0。jar和所有随swagger jaxrs jar 1.5.0版本附带的jar(如果有用的话,我可以包括一个完整的列表),我已经注释了一些方法,我有一个如下的配置类: }
编译得很好,但当我使用BootRun命令启动应用程序时,它失败了,原因是: 会有什么问题?不兼容Java9?那我能让它发挥作用吗?
我使用Springboot大摇大摆3: 我对所有endpoint使用默认的前缀。 这就是我如何配置我的SwaggerConfig: 当我尝试访问我的swagger-ui 我得到一个弹出窗口,其中包含此消息要求我定义位置。 当我手动输入前缀:< code>http://myhost/api时,一切正常。 任何想法如何定义我的REST API前缀吗?