*공부한 내용을 토대로 혼자서 정리하는 글입니다.
틀린 부분이나 보충할 부분 지적 언제든 환영합니다 :)
RESETful
RESTful API란?
웹에서 사용되는 데이터나 자원(Resource)을 HTTP URI로 표현하고,
HTTP 프로토콜을 통해 요청과 응답을 정의하는 방식
strapi
실행 명령어
- strapi가 설치된 디렉토리로 이동
-npm run develop: 시작 명령어
- Ctrl + C : 종료- http://localhost:1337/admin 로 접속
문제풀이
Q . 블로그 서비스의 API 내용 작성
- 특정 블로그글의 댓글조회
특정 블로그의 글들은 articles로 접근
하나의 블로그 글에 접근할 때는 unique한 숫자(ID)로 접근
하나의 글에 달려있는 댓글들은 comments로 접근
특정 블로그 글에 달린 댓글은 다음의 EndPoint로 접근 가능
➡ /articles/{aid:Number}/comments
- 댓글
조회(READ)결과를 응답으로 받아오면 되므로➡ GET /articles/{aid:Number}/comments
- 잘 받아오면 200 응답 코드와 함께 댓글들 목록을 받아올 것
➡ 목록의 표현방식이나 내역은 개발자가 어떻게 구현하느냐에 따라 다름
- 블로그 좋아요
특정 블로그의 글들은 articles로 접근
articles중 하나의 글에 접근할 때는 숫자로 접근
하나의 글에 좋아요는 likes로 접근
특정 블로그 글의 좋아요는 다음의 EndPoint로 접근 가능
➡ /articles/{aid:Number}/likes
- likes에는 좋아요 누른 유저가 누군지에 대한 정보를 포함해서 수정해야 하므로
➡ PUT /articles/{aid:Number}/likes
➡ 보안을 위해 해당 API를 쓸 때에는 토큰같은 수단으로 인증된 유저가 사용!
➡ Authorization Header를 활용하여 유저 정보를 전송함.
- 좋아요가 처리가 잘되면 200 응답 코드와 좋아요 수 하나가 늘어남.
- 블로그 취소
특정 블로그의 글들은 articles로 접근
articles중 하나의 글에 접근할 때는 숫자로 접근
하나의 글에 좋아요는 likes로 접근
특정 블로그 글의 좋아요는 다음의 EndPoint로 접근 가능
➡ /articles/{aid:Number}/likes
- likes에는 좋아요를 이미 누른 유저가 취소하는 것이기에 좋아요 누른 유저 목록에서 삭제해야 하므로
➡ DELETE /articles/{aid:Number}/likes
➡ 보안을 위해 해당 API를 쓸 때에는 토큰같은 수단으로 인증된 유저가 사용!
➡ Authorization Header를 활용하여 유저 정보를 전송함.
- 처리가 잘되면 200 응답 코드와 좋아요 수 하나가 줄어듦.
- 다른 글쓴이 Follow
User 각각의 정보는 username으로 접근. username은 unique하기 때문
각 User의 follower 정보는 followers로 접근
특정 User의 follow은 다음의 EndPoint로 접근 가능
➡ /{username:String}/followers
- 어떤 사람이 Follow했는지 알아야 하므로 User의 follower 정보 안에 다른 User의 정보가 생성 되어야 함.
➡ POST /{username:String}/followers
➡ 보안을 위해 해당 API를 쓸 때에는 토큰같은 수단으로 인증된 유저가 사용!
➡ Authorization Header를 활용하여 유저 정보를 전송함.
- 잘 받아오면 201 응답 코드와 함께 Follow수가 늘어나면서 목록에 추가
- 다른 글쓴이 Follow 취소
User 각각의 정보는 username로 접근
각 User의 follower 정보는 followers로 접근
특정 User의 follow은 다음의 EndPoint로 접근 가능
➡ /{username:String}/followers
- Follow한 사람이 취소해야 하므로 취소하려는 User의 정보가 follow하는 User의 follower 목록에서 삭제 되어야 함.
➡ DELETE /{followed_user:String}/followers/
➡ 보안을 위해 해당 API를 쓸 때에는 토큰같은 수단으로 인증된 유저가 사용!
➡ Authorization Header를 활용하여 유저 정보를 전송함.
- 요청이 잘 받아들여지면 200 응답 코드와 함께 Follow수가 감소
