DCAMP FRONTEND API 개발 가이드 » 이력 » 개정판 12
개정판 11 (최시은, 2023-05-26 00:22) → 개정판 12/31 (최시은, 2023-05-26 00:27)
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 Rule
* 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 정의
* Naming Rule : HttpMethod + 대메뉴(복수 or 단수) or 주 사용 테이블 + Req/Res
<pre>
예시)
- GetProjectsReq : 프로젝트 목록 조회 요청
- GetProjectsRes : 프로젝트 목록 조회 응답
- PostProjectReq : 프로젝트 생성 요청
- 애매한 경우는 적당히 클래스명만 보고 가늠할 수 있게 지정해주세요
</pre>
* 공통 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 : 페이징 목록 조회 시 Response 객체로 사용
<pre><code class="java">
@GetMapping
public ResponseEntity<CommonListRes<GetProjectsRes>> list(GetProjectsReq req) throws Exception {
CommonListRes<GetProjectsRes> response = projectService.list(req);
return new ResponseEntity<>(response, HttpStatus.OK);
}
</code></pre>
** CommonSearch : 페이징 목록의 검색 시 Request 객체가 상속 받아 사용(페이징 정보 담김)
<pre><code class="java">
@AllArgsConstructor
@NoArgsConstructor
@Setter
@Getter
@EqualsAndHashCode(callSuper = false)
public class GetProjectsReq extends CommonSearch {
private String projectStatusCcd;
private String searchType;
private String searchWord;
}
</code></pre>
** CommonPagination : 페이징 처리를 위해 CommonListRes에서 사용(따로 사용할 일 없음)
5. Entity 폴더
* 정의 : JPA 에서 사용할 Entity 정의
6. DTO 객체와 Entity 객체 분리 사용
* 이유 : https://wildeveloperetrain.tistory.com/101
* DTO <-> Entity 는 BeanUtils.copyProperties 사용(필드명 일치시켜야함)
<pre><code class="java">
public Project createProject(PostProjectReq req, UserDetails userDetails) {
Project saveProject = new Project();
String userId = userDetails.getUsername();
saveProject.setRegId(userId);
// DTO <-> Entity 변환
BeanUtils.copyProperties(req, saveProject);
saveProject = projectRepository.save(saveProject);
return saveProject;
}
</code></pre>
7. 현재 로그인한 아이디 가져오기(regId 에 주로 사용)
* Spring security 에서 제공하는 @AuthenticationPrincipal 사용해 UserDetails 객체 가져옴
* userDetails.getUsername() 으로 로그인ID 사용
<pre><code class="java">
@PostMapping
public ResponseEntity<CommonRes> save(@AuthenticationPrincipal UserDetails userDetails, @RequestBody PostProjectReq req) throws Exception {
// String userId = userDetails.getUsername();
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>