Tips. API 공유, 문서화

yeeun lee·2020년 4월 28일
0

1. API 붙이는 법

- 프론트엔드에 ip 공유

  • 터미널에 ifconfig를 입력한다
  • en0으로 시작하는 라인에 있는 ip를 복사한다.
  • ip는 매일 바뀌기 때문에 daily base로 공유되어야 하고, 혹시 다른 것은 다 괜찮은데 연결이 안 될 경우 혹시 ip가 바뀌지는 않았는지 확인한다.

- django settings.py

  • root app > settings.py > allowed_host 에서 *, 내 ip, 내 ip:8000 추가한다.
  • 서버를 열 때 python manage.py runserver 0:8000 을 꼭 붙여줘야 한다.

2. API 공유 문서 만들기

세션 링크 링크 찾는게 어려워서 나중에 찾기 위해서 저장 😖

API 문서화는 직접 정리하는 것이 어렵기 때문에 postman을 통해 정리하는 것이 좋다. 문서를 보고 이렇게 호출하면 된다 프론트에 알려주는 것!

- how to

collection에서 점 세개 누르면 pubilsh docs가 있고, 외부 링크로 넘어가서 기록한 내용을 링크로 저장할 수 있게 된다.

postman에서 API가 잘 돌아가는지 미리 테스트할 수 있고, 해당 내용을 저장해 프론트엔드에 데이터의 형태를 보여줄 수 있다.

profile
이사간 블로그: yenilee.github.io

0개의 댓글