1,引包
<dependency>
<groupId>com.spring4all</groupId>
<artifactId>swagger-spring-boot-starter</artifactId>
<version>1.7.0.RELEASE</version>
</dependency>
2,在启动类加注解
@EnableSwagger2
@SpringBootApplication
public class UrlshipApplication {
public static void main(String[] args) {
SpringApplication.run(UrlshipApplication.class, args);
}
}
3,在接口上加接口说明
@Controller
@Api(value ="节点管理")
@RequestMapping("/node/")
public class NodeController {
@Autowired
private NodeServ serv;
@ApiOperation(value = "新增节点", notes = "新增节点")
@RequestMapping({"addnode"})
@ResponseBody
public String addNode(@ApiParam(value = "节点信息",required = true) NodeFO node){
try {
this.serv.addNode(node);
}catch(Exception e){
e.printStackTrace();
}
return "1";
}
}
4,处理拦截器(如果没有配置拦截器或者不知道拦截器,可以忽略此步骤)
@Configuration
public class TokenConfiguration extends WebMvcConfigurerAdapter {
@Autowired
private TokenInterceptor tokenInterceptor;
@Bean
TokenInterceptor tokenInterceptor() {
return new TokenInterceptor();
}
@Override
public void addInterceptors(InterceptorRegistry registry ){
registry.addInterceptor(tokenInterceptor).addPathPatterns("/**")
.excludePathPatterns("/swagger-resources/**", "/webjars/**","/v2/**", "/swagger-ui.html/**");
}
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("/static/**").addResourceLocations("classpath:/static/");
registry.addResourceHandler("swagger-ui.html")
.addResourceLocations("classpath:/META-INF/resources/");
registry.addResourceHandler("/webjars/**")
.addResourceLocations("classpath:/META-INF/resources/webjars/");
super.addResourceHandlers(registry);
}
}
5,启动项目,打开链接
http://localhost/swagger-ui.html