Project

일반

사용자정보

이력

Wiki »

DCAMP FRONTEND API 개발 가이드 » 이력 » 개정판 6

개정판 5 (최시은, 2023-05-25 23:53) → 개정판 6/31 (최시은, 2023-05-25 23:58) 

h2. DCAMP FRONTEND API 개발 가이드 

 1. SecurityConfig 설정(security/config/SecurityConfig.java) 
 *    securityFilterChain 메소드 - 개발 진행할 URL 에 대한 hasAuthority 룰 추가 
 <pre><code class="java"> 
 http.csrf().disable() 
      .authorizeHttpRequests((authorize) -> 
            authorize 
                // hasAuthority 사용: db에 ROLE_ 안붙여도 됨 
               .requestMatchers("/projects/**").hasAuthority("ADMIN") // 관리자 : ADMIN | 작업자&검수자 : USER 
               .anyRequest().authenticated() 
 </code></pre> 

 2. Swagger 사용 
 * 설정 파일 위치 : common/config/SwaggerConfig.java (이미 설정되어 있으므로 따로 추가사항 없음) 
 * 접속 URL : http://localhost:18080/swagger-ui/index.html 
 login-controller 에서 로그인 후, 응답 토큰을 우상단 Authorized 버튼 클릭해서 입력하면 인증 가능 

 3. Request URL Naming 
 * RESTful API 기반 : https://restfulapi.net/resource-naming/ 
 * 1 Depth : 대메뉴(ex, project, user 등등) 
 <pre>http://api.example.com/user-management/users 
 http://api.example.com/user-management/users/{id}</pre> 

 4. DTO 폴더 
 * 정의 : API 통신용 Request, Response 정의 
 * 공통 DTO 클래스 
 ** CommonRes : 공통 응답필드(result, message) 정의, 상황에 따른 payload 세팅 가능 
 <pre><code class="java"> 
 @PostMapping 
     public ResponseEntity<CommonRes> save(@AuthenticationPrincipal UserDetails userDetails, @RequestBody PostProjectReq req) throws Exception { 
         Project project = projectService.createProject(req, userDetails); 
         CommonRes response = project != null ? new CommonRes() : CommonRes.builder().result(false).message("오류가 발생했습니다.").build(); 
         return new ResponseEntity<>(response, HttpStatus.OK); 
     } 
 </code></pre> 

 ** CommonListRes : 페이징 처리된 목록 조회 시 사용