API란, 한 프로그램에서 다른 프로그램의 기능을 사용할 수 있도록 제어가능한 인터페이스이다.HTTP 프로토콜을 사용하여 프로그램에서 다른 프로그램의 기능을 사용할 수 있도록 제어가능한 인터페이스이다.
| HTTP 메소드 | 행위 |
|---|---|
| GET | 서버의 특정 자원을 가져온다. (읽기) |
| POST | 서버의 특정 자원에 대한 정보를 등록한다. (쓰기) |
| PUT | 서버의 특정 자원에 대한 모든 정보를 수정한다. (수정) |
| PATCH | 서버의 특정 자원에 대한 일부 정보만 수정한다. (수정) |
| DELETE | 서버의 특정 자원을 삭제한다. (삭제) |
REST API를 구성할때는 몇개의 규칙이 있다.
<aside>
💡 Bad: http://localhost:8080/Running
Good: http://localhost:8080/run
</aside>
<aside>
💡 Bad: [DELETE] http://localhost:8080/posts/delete/1
Good: [DELETE] http://localhost:8080/posts/1
</aside>
RESTFUL API라고 부른다.게시판 프로젝트를 구현할때 사용되는 REST API들을 일부 알아보자.
<aside>
💡 모든 게시글 불러오기
GET http://localhost:8080/posts
상세 게시글 불러오기
GET http://localhost:8080/posts/1(게시글 id)
회원가입
POST http://localhost:8080/auth/sign-up
body: {
email: string;
name: string;
password: string;
}
로그인
POST http://localhost:8080/auth/sign-in
body: {
email: string;
password: string;
}
</aside>