github wiki에 api 명세 작성하기

API를 개발한 뒤에는 프론트 팀으로 넘겨야하는데…

• 어떻게 설명해주면 좋을까?
  • 만나서 말로? → 미쳤지 그냥
  • 문서로 ㅇㅇ
• 그래서 API를 넘겨주는 다양한 방법이 있다.
  • swagger라는 툴이 대표적인 방법이다.
  • 다만, 이 툴을 추가로 사용할 경우 백파트와 프파트 모두 새로운 툴을 공부해야하는 피로가 생긴다.
  • 따라서, github상에 설명을 작성할 수 있는 기능인 wiki를 사용해보려고 한다.

사용법

• 우리 레포다
• 들어가면 당연히 디렉토리와 리드미가 나를 반겨준다.
• 위 메뉴를 보다 보면, Wiki라는 메뉴를 찾아볼 수 있다.

• 이동해보면, 기본적으로 작성해놓은 내용을 볼 수 있다.
• 이걸 참고해서 (양식은 동일하게) 작성하도록 한다.
• github wiki에는 마크다운으로 작성할 수 있다.

 

 

• 마크다운 작성하기
• https://docs.github.com/ko/get-started/writing-on-github/working-with-advanced-formatting

고급 서식 지정 작업 - GitHub Docs

• wiki에 api 명세 작성하기 예시
• https://github.com/TAKE-US/TAKEUS-BACK/wiki

Home