Feature/faq

[YongJun-Lee-98]

💡 Issue

• 이슈

📌 Work Description

• FAQ api 구현
• json 형태의 리턴
• pagenation 적용
• ERROR 리턴 시 WEB에 전달 code자체는
  code가 전달되었다는 의미로 success(200)를 리턴
  "status":{} json값으로 SUCCESS/ERROR 불리언 값 리턴 후
• json에서 ERROR 발생 시 = "error":{"종류", "message"}
• json에서 ERROR 미발생 시 "error":None

✅ 테스트 항목

• FAQ 기능 테스트

📝 Reference

프론트 협의 내용

• 적용사항

1. api status return 200
2. pagenation "?page=1&page_size=10" 의 형태로 원하는 페이지의 양

📚 Etc

[jungmir]

Swagger를 사용 할 예정이라 README에서 사용 예시는 없어도 될 것 같습니다.

[YongJun-Lee-98]

아.. 그 테스트 할 때 좀 편하게 하시라고 넣어뒀는데 삭제하겠습니다
예시 curl로 터미널에서 복붙해서 오류 있는지 확인차. 해보던 코드입니닷

[jungmir]

로컬 애플리케이션과 외부 라이브러리가 구분되면 좋을 것 같습니다

[YongJun-Lee-98]

반영하겠습니다

[jungmir]

FAQ의 router는 faq.urls 모듈에서 관리하는 게 좋을 것 같은데 다른분들 의견은 어떠신가요?

[jungmir]

Swagger와 redoc 문서는 Debug 환경 혹은 개발 환경에서만 보이는게 좋을 것 같습니다.

[YongJun-Lee-98]

if settings.DEBUG:
사용해서 해당 내용 반영할 수 있도록 하겠습니다

[jungmir]

apps 모듈과 settings에서 기본 ID 필드에 대한 정의가 있어서 BaseModel에 따로 정의하지 않아도 될 것 같습니다.

[jungmir]

공지사항도 FAQ 도메인에서 관리 하시려는 건가요?

[YongJun-Lee-98]

Notice는 따로 뺏는데 실수로 코드가 같이 들어간거 같습니다
수정하겠습니다.

[jungmir]

FAQ 뿐만 아니라 다른 ViewSet에서도 동일한 pagination 설정을 사용할 것 같은데
글로벌에서 접근해서 사용할 수 있도록 별도 모듈로 처리하면 어떨까요?

settings.py에 기본 pagniation 클래스를 지정해서 사용해도 괜찮을 것 같습니다.

[YongJun-Lee-98]

관련해서 settings.py에 일단 기본설정(10개)은 등록해뒀는데
다음 PR에서 해당 내용 Default 값 사용할 수 있도록 수정하겠습니다.

[YongJun-Lee-98]

다만 한번 요청에서 최대 값(max_page_size)을 지정하려면
class로 구상해야 할 것 같고
요청하는 최댓값이 필요 없다고 생각되면 Default에 정의한걸 사용하도록 하겠습니다.