{"id":1450,"date":"2020-11-09T22:02:24","date_gmt":"2020-11-09T13:02:24","guid":{"rendered":"https:\/\/www.skyer9.pe.kr\/wordpress\/?p=1450"},"modified":"2021-12-05T03:24:57","modified_gmt":"2021-12-04T18:24:57","slug":"swagger-ui-%ec%84%a4%ec%a0%95%ed%95%98%ea%b8%b0","status":"publish","type":"post","link":"https:\/\/www.skyer9.pe.kr\/wordpress\/?p=1450","title":{"rendered":"Swagger UI 2 \uc124\uc815\ud558\uae30"},"content":{"rendered":"

Swagger UI 2 \uc124\uc815\ud558\uae30<\/h1>\n

\uc758\uc874\uc131 \ucd94\uac00<\/h2>\n
dependencies {\n    implementation 'io.springfox:springfox-swagger-ui:2.9.2'\n    implementation 'io.springfox:springfox-swagger2:2.9.2'\n}<\/code><\/pre>\n
Swagger \ud65c\uc131\ud654<\/h2>\n
@Configuration\n@EnableSwagger2\npublic class SwaggerConfig {\n\n    @Bean\n    public Docket api() {\n        return new Docket(DocumentationType.SWAGGER_2)\n                .select()\n                .apis(RequestHandlerSelectors.any())\n                .paths(PathSelectors.ant("\/api\/**"))\n                .build();\n    }\n}<\/code><\/pre>\n
\ube0c\ub77c\uc6b0\uc800\uc5d0\uc11c http:\/\/localhost:8080\/swagger-ui.html<\/a> \ub97c \uc811\uc18d\ud558\uba74 Swagger UI \uac00 \uc2e4\ud589\ub41c \uac83\uc744 \ud655\uc778\ud560 \uc218 \uc788\uc2b5\ub2c8\ub2e4.<\/p>\n
\ucee8\ud2b8\ub864\ub7ec\uc5d0 annotation \ucd94\uac00<\/h2>\n
ApiOperation<\/code> annotation \uc744 \ucd94\uac00\ud558\uba74 \ud55c\uae00 \uc124\uba85\uc744 \uba54\uc18c\ub4dc\uc5d0 \ucd94\uac00\ud560 \uc218 \uc788\uc2b5\ub2c8\ub2e4.<\/p>\n
ApiImplicitParams<\/code> \uc744 \uc774\uc6a9\ud574 \ud30c\ub77c\ubbf8\ud130\uc5d0 \ub300\ud55c \ud55c\uae00 \uc124\uba85\uc744 \ucd94\uac00\ud560 \uc218 \uc788\uc2b5\ub2c8\ub2e4.<\/p>\n
@RequiredArgsConstructor\n@RestController\npublic class MenusApiController {\n\n    private final MenusService menusService;\n\n    @ApiOperation(value = "\uba54\ub274 \uc800\uc7a5", notes = "\uba54\ub274 \uc544\uc774\ud15c\uc744 \uc2e0\uaddc\ub4f1\ub85d\ud569\ub2c8\ub2e4.")\n    @PostMapping("\/v1\/settings\/menu")\n    public ResponseWithDataDto save(@RequestBody MenusSaveRequestDto menusSaveRequestDto) {\n        return menusService.save(menusSaveRequestDto);\n    }\n\n    @ApiOperation(value = "\uba54\ub274 \uc870\ud68c", notes = "\uba54\ub274 \uc544\uc774\ud15c\uc744 \uc870\ud68c\ud569\ub2c8\ub2e4.")\n    @ApiImplicitParams({\n            @ApiImplicitParam(name = "id", value = "\uba54\ub274 ID", required = true, dataType = "int", paramType = "path", defaultValue = ""),\n    })\n    @GetMapping("\/v1\/settings\/menu\/{id}")\n    public ResponseDto findById(@PathVariable Integer id) {\n        return menusService.findById(id);\n    }\n}<\/code><\/pre>\n
\ud5e4\ub354 \ucd94\uac00<\/h2>\n
List<Parameter><\/code> \ub97c \uc774\uc6a9\ud574 \ud5e4\ub354\ub97c \ucd94\uac00\ud560 \uc218 \uc788\uc2b5\ub2c8\ub2e4.<\/p>\n
@Configuration\n@EnableSwagger2\npublic class SwaggerConfig {\n\n    @Bean\n    public Docket api() {\n\n        ParameterBuilder parameterBuilder = new ParameterBuilder();\n        List<Parameter> parameters = new ArrayList<>();\n\n        parameterBuilder\n                .name("X-Authorization")\n                .modelRef(new ModelRef("string"))\n                .parameterType("header")\n                .required(false)\n                .build();\n        parameters.add(parameterBuilder.build());\n\n        return new Docket(DocumentationType.SWAGGER_2)\n                .globalOperationParameters(parameters)\n                .select()\n                .apis(RequestHandlerSelectors.any())\n                .paths(PathSelectors.ant("\/v1\/**"))\n                .build();\n    }\n}<\/code><\/pre>\n
Spring Security<\/h2>\n
Spring Security \uac00 \ud65c\uc131\ud654 \ub418\uc5b4 \uc788\ub294 \uacbd\uc6b0, "\/swagger-ui.html"<\/code>, "\/webjars\/**"<\/code>, "\/swagger-resources\/**"<\/code>, "\/v2\/api-docs\/**"<\/code> \ub97c \ud5c8\uc6a9\ud574 \uc8fc\uc5b4\uc57c \ud569\ub2c8\ub2e4.<\/p>\n
@EnableWebSecurity\npublic class WebSecurityConfig extends WebSecurityConfigurerAdapter {\n\n    \/\/ ......\n\n    @Override\n    protected void configure(HttpSecurity http) throws Exception {\n\n        http\n                .addFilterBefore(corsFilter(), SessionManagementFilter.class)\n                .addFilterBefore(rsaHeaderKeyFilter(), BasicAuthenticationFilter.class)\n                .authorizeRequests().antMatchers("\/health\/**",\n                        "\/v1\/user\/**",\n                        "\/swagger-ui.html",\n                        "\/webjars\/**",\n                        "\/swagger-resources\/**",\n                        "\/v2\/api-docs\/**").permitAll()\n                .anyRequest().authenticated()\n                .and()\n                .csrf().disable();\n    }\n\n    \/\/ ......\n}<\/code><\/pre>\n
DTO \uc5d0 \uc608\uc81c\uac12 \ud45c\uc2dc<\/h2>\n
@Getter\n@NoArgsConstructor\npublic class MenusSaveRequestDto implements Serializable {\n\n    @ApiModelProperty(example = "0")\n    private Integer pidx;\n    @ApiModelProperty(example = "\ud14c\uc2a4\ud2b8 \uba54\ub274")\n    private String menuName;\n    @ApiModelProperty(example = "Y")\n    private String useyn;\n}<\/code><\/pre>\n","protected":false},"excerpt":{"rendered":"
Swagger UI 2 \uc124\uc815\ud558\uae30 \uc758\uc874\uc131 \ucd94\uac00 dependencies { implementation 'io.springfox:springfox-swagger-ui:2.9.2' implementation 'io.springfox:springfox-swagger2:2.9.2' } Swagger \ud65c\uc131\ud654 @Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2) .select() .apis(RequestHandlerSelectors.any()) .paths(PathSelectors.ant("\/api\/**")) .build(); } } \ube0c\ub77c\uc6b0\uc800\uc5d0\uc11c http:\/\/localhost:8080\/swagger-ui.html \ub97c \uc811\uc18d\ud558\uba74 Swagger UI \uac00 \uc2e4\ud589\ub41c \uac83\uc744 \ud655\uc778\ud560 \uc218 \uc788\uc2b5\ub2c8\ub2e4. \ucee8\ud2b8\ub864\ub7ec\uc5d0 annotation \ucd94\uac00 ApiOperation annotation \uc744 \ucd94\uac00\ud558\uba74 \ud55c\uae00\u2026 Read More »<\/a><\/span><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[8],"tags":[],"class_list":["post-1450","post","type-post","status-publish","format-standard","hentry","category-java"],"_links":{"self":[{"href":"https:\/\/www.skyer9.pe.kr\/wordpress\/index.php?rest_route=\/wp\/v2\/posts\/1450","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.skyer9.pe.kr\/wordpress\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.skyer9.pe.kr\/wordpress\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.skyer9.pe.kr\/wordpress\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.skyer9.pe.kr\/wordpress\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=1450"}],"version-history":[{"count":22,"href":"https:\/\/www.skyer9.pe.kr\/wordpress\/index.php?rest_route=\/wp\/v2\/posts\/1450\/revisions"}],"predecessor-version":[{"id":4070,"href":"https:\/\/www.skyer9.pe.kr\/wordpress\/index.php?rest_route=\/wp\/v2\/posts\/1450\/revisions\/4070"}],"wp:attachment":[{"href":"https:\/\/www.skyer9.pe.kr\/wordpress\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=1450"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.skyer9.pe.kr\/wordpress\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=1450"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.skyer9.pe.kr\/wordpress\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=1450"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}