Swagger 構成:
@EnableSwagger
@Configuration
public class SwaggerConfig {
private SpringSwaggerConfig springSwaggerConfig;
@Autowired
public void setSpringSwaggerConfig(SpringSwaggerConfig springSwaggerConfig) {
this.springSwaggerConfig = springSwaggerConfig;
}
@Bean
public SwaggerSpringMvcPlugin swaggerSpringMvcPlugin() {
return new SwaggerSpringMvcPlugin(springSwaggerConfig)
.swaggerGroup("sample-app")
.includePatterns(
"/account/*"
)
.apiInfo(apiInfo())
.build();
}
private ApiInfo apiInfo() {
ApiInfo apiInfo = new ApiInfo(
"sample-app",
"sample-app doc",
"",
"support@sample-app",
"",
""
);
return apiInfo;
}
レストコントローラー
@RestController
@RequestMapping(value = "/account")
@Api(value = "Change Account details", description = "")
public class ChangeAccountController {
@ApiOperation(value = "Change address")
@RequestMapping(value = "/addresschange", method = RequestMethod.POST)
public String addressChange(HttpServletRequest httpRequest, HttpServletResponse httpResponse,
@Valid @RequestBody User user) throws ServletException, IOException {
// logic and return something!
}
}
参照:一部の情報はここから参照されています: http://java.dzone.com/articles/how-configure-swagger-generate
問題/質問:
メソッドでは、API としてパターンをSwaggerConfig.java
指定すると、Swagger 出力ページに表示されませんが、パターンをそのまま含めると表示されます。なんで?このユースケースのとの違いは何ですか?includePatterns()
/account/*
/account/.*
/account/*
/account/.*
アップデート:
別のユースケース
@RestController
@RequestMapping(value = "/score")
@ApiOperation(value = "All score", notes = "")
@RequestMapping(value = "", method = RequestMethod.GET)
public @ResponseBody ActionResult allScores(HttpServletRequest httpRequest,
HttpServletResponse httpResponse) {
}
パターンを として追加すると/score/*
、API が Swagger に表示されます。パターンを次のように配置する必要はありません/score/.*