SpringFox用于在SpringMVC中整合Swagger，提供web api文檔。

參考：

首先直接上個最簡單的demo，

@Configuration

@EnableWebMvc

@EnableSwagger2public classSpringfoxConfiguration {

@BeanpublicDocket docket() {return newDocket(DocumentationType.SPRING_WEB);

}

}

確定在Spring能掃描到此配置類：

因為Swagger-UI作為訪問入口，但里面全是靜態(tài)資源，獲取具體應用的Controller/RequestMapping信息的url都是寫死在文件里面的，目前筆者所用的2.6.1版本中，這個configuration url是/configuration/ui(相對于swagger-ui.html)，configuratio/ui對應了springfox中的一個Controller/RequestMapping，相關代碼如下：

springfox-swagger-common/src/main/java/springfox/documentation/swagger/web/ApiResourceController.java.....privateSecurityConfiguration securityConfiguration;

@Autowired(required= false)privateUiConfiguration uiConfiguration;

Optional.fromNullable(securityConfiguration).or(SecurityConfiguration.DEFAULT), HttpStatus.OK);

}

@RequestMapping(value= "/configuration/ui")

@ResponseBodypublic ResponseEntity uiConfiguration() {

.......

目前swagger的靜態(tài)資源作為一個jar包依賴進來，運行時它在我們的classpath中，因此我們配置一下ResourceHandler

@Configurationpublic class SpringMvcConfig extendsWebMvcConfigurerAdapter{

@Overridepublic voidaddResourceHandlers(ResourceHandlerRegistry registry) {

registry.addResourceHandler("/swagger-ui.html**")

.addResourceLocations("classpath:/META-INF/resources/swagger-ui.html");

registry.addResourceHandler("/webjars/**")

.addResourceLocations("classpath:/META-INF/resources/webjars/");super.addResourceHandlers(registry);

}

}

這里就來問題了，因為swagger-ui里面靜態(tài)資源訪問configuration/ui的時候使用的是相對路徑，如果你配置了swagger-ui.html映射到/documentation/swagger-html**的話，那么就會訪問/documentation/configuration/ui去獲取應用信息。但是從上面ApiResourceController可以看到，/configuration/ui是寫死在代碼里面的，很多同學可能在這里出現(xiàn)了404。當然springfox給出一些解決方案，但一般將swagger-ui.html配置到DispatcherServlet的虛擬目錄下面即可。

下面來配置一個json的例子：

@Validate

@ApiOperation(value="register user", consumes="application/json", produces="application/json")

@RequestMapping(path="/registerUser", method={RequestMethod.POST}, consumes={"application/json"}, produces={"application/json; charset=utf-8"})public ActionResponse regisetrUser(@RequestBody finalUserVo userVo){final User userToRegister =UserUtils.voToBo(userVo);final User registeredUser =userService.registerUser(userToRegister, userVo.getPassword());final UserVo registeredUserVo =UserUtils.boToVo(registeredUser);returnok(registeredUserVo);

}

總結(jié)

以上是生活随笔為你收集整理的java netfox_SpringFox集成原理的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。