<aside> 👨🏻‍🏫 안녕하세요! JSCODE 프론트엔드 개발자 벨라입니다. UI에 관련된 구현이 끝나서 API 문서 만들어주시면, API 연결할 수 있게 미리 세팅해놓겠습니다!

</aside>

✅ 학습 목표

• API 문서 작성

✅ 요구 사항

아래 API에 대해 API 문서를 작성해라.

1. 게시글 작성 기능
2. 게시글 전체 조회 기능
3. 특정 게시글 조회 기능
4. 특정 게시글 수정 기능
5. 특정 게시글 삭제 기능
6. 게시글 검색 기능

✅ 제약 조건

• Swagger, Github Wiki, Notion, Postman, Gitbook 중 사용하기
• API 문서에 아래의 내용은 반드시 포함시키기
  • URL 주소 / HTTP 메서드
  • API 설명
  • 요청 형태
    • Path Parmas
    • Query Params
    • Body Params
    • 필수 여부
    • 데이터 타입
  • 응답 형태
    • 응답 코드(status code)
    • 각 응답 코드별 설명
    • 응답 형태 (response value)
    • 응답 값에서 각 파라미터의 의미
    • 응답 값에서 각 파라미터의 필수 여부
    • 응답 값에서 각 파라미터의 데이터 타입