API 명세서 작성

·2023년 9월 12일
0

파이썬

목록 보기
15/18

1. 개요

  • 이 API 는 사용자 정보를 받아 본인 및 다른 사람들이 작성한 글과 사용자의 정보를 보여주는 기능을 합니다.

2. 엔드포인트 및 경로

  • POST /login : 로그인
  • POST /signup : 회원가입
  • GET /feed/feedlist : 작성된 게시물의 피드와 접속한 사용자를 보여누는 기능
  • POST /create : 피드를 작성할 수 있는 페이지
  • POST /myfeed/<int:id> : 접속한 사용자가 쓴 피드를 모아볼 수 있는 페이지
  • GET /mypage/<int:id> : 사용자의 정보를 볼 수 있는 페이지
  • POST /mypage/update/<int:id> : 프로필 업데이트를 할 수 있는 페이지

3. req/res

로그인

POST /login

request

{
	'username': 'hyelee',
    'password': '1029'
}

response

피드 보기

GET /feedlist

마이페이지

GET /mypage/<int:id>

request

{
	'username': 'hyelee',
    'password': '1029'
}

response

나의 피드 보기

GET /myfeed/<int:id>

request

{
	'username': 'hyelee',
    'password': '1029'
}

response

다른 이용자의 피드 보기

피드 작성

POST /feed/create

request

{
	'title': 'test',
    'content': 'test2'
}

response

에러

403 : crsf 토큰 설정 관련 오류입니다. settings.py 에서 'django.middleware.csrf.CsrfViewMiddleware' 를 주석처리 하거나 postman 의 test 부분에

var xsrfCookie = postman.getResponseCookie("csrftoken"); 
postman.setGlobalVariable('csrftoken', xsrfCookie.value);

을 추가해준 뒤 Headers 에 X-CSRFToken : {{csrftoken}} 를 추가해줍니다.

profile
공부 중

0개의 댓글