Restful API Design

Hayoung Kim·2020년 11월 18일
0

SpringFramework

목록 보기
6/9

HTTP의 Method에 따라 CRUD 동작을 하도록 한다.

  • GET : 조회
  • POST : 생성
  • PUT : 수정
  • PATCH : 수정
  • DELETE : 삭제

왜?

어떻게?

1. 정의한 API 구조

ActionMethodURLDesc
전체 유저 정보GET/user
특정 유저 정보GET/user/id
유저 검색 정보GET/user/search
신규 유저 추가POST/userDTO 사용
특정 유저 갱신PUT/userDTO 사용, 전체 데이터를 갱신
특정 유저 갱신PATCH/userDTO 사용 or PK+Information, 부분 갱신
특정 유저 삭제DELETE/user/id
특정 유저 삭제DELETE/userDTO 사용

2. 구현

Entity
@RequiredArgsConstructor
@Data
@EqualsAndHashCode(callSuper=false)
@Entity
@Table(name = "TB_USER")
public class User extends CommonAudit {
	@Id
	@Column(length= 50, nullable=false)
	private Long id;
	
    @Column(length = 20, nullable = false) //varchar 20
    private String company;

    @Column(length = 20, nullable = false)
    private String empno;

    @Column(length = 20, nullable = false)
    private String name;

    @Column(nullable = false)
    private int age;
}

0개의 댓글