api-rule.mdc 4.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152
  1. # 최우선 규칙: 한글 응답 필수
  2. **모든 응답은 한글로만 작성해야 함. 이 규칙은 다른 모든 규칙보다 우선한다.**
  3. # API & Store Rules
  4. ## Pinia Store Rules
  5. ### 1. Setup Syntax Store Reset 구현
  6. - Setup 문법(`defineStore(() => {...})`)으로 작성된 store는 자동 `$reset()`이 제공되지 않음
  7. - 반드시 수동으로 `reset()` 함수를 구현해야 함
  8. ```typescript
  9. // Good
  10. export const useMyStore = defineStore('myStore', () => {
  11. const data = ref([])
  12. const loading = ref(false)
  13. // 수동으로 reset 함수 구현
  14. function reset() {
  15. data.value = []
  16. loading.value = false
  17. }
  18. return {
  19. data,
  20. loading,
  21. reset // reset 함수 반환 필수
  22. }
  23. })
  24. // Bad - reset 함수 없음
  25. export const useMyStore = defineStore('myStore', () => {
  26. const data = ref([])
  27. return { data }
  28. })
  29. ```
  30. ### 2. Reset 함수 구현 가이드
  31. - 모든 state를 초기값으로 되돌리는 로직 포함
  32. - 중첩된 객체의 경우 깊은 복사 고려
  33. - persist 옵션이 있는 경우 저장소 데이터도 정리
  34. ```typescript
  35. function reset() {
  36. // 단순 값 초기화
  37. simpleValue.value = null
  38. // 객체 초기화
  39. objectValue.value = {
  40. prop1: '',
  41. prop2: 0
  42. }
  43. // 배열 초기화
  44. arrayValue.value = []
  45. // 중첩 객체 초기화
  46. complexValue.value = JSON.parse(JSON.stringify(DEFAULT_STATE))
  47. }
  48. ```
  49. ### 3. Store 초기화 호출 방식
  50. - Setup 문법 store: `store.reset()`
  51. - Options 문법 store: `store.$reset()`
  52. ```typescript
  53. // Setup store
  54. const setupStore = useSetupStore()
  55. setupStore.reset() // O
  56. setupStore.$reset() // X - 에러 발생
  57. // Options store
  58. const optionsStore = useOptionsStore()
  59. optionsStore.$reset() // O
  60. ```
  61. ### 4. Store 초기화 시점
  62. - 로그아웃
  63. - 사용자 전환
  64. - 주요 상태 변경
  65. - 에러 복구
  66. ```typescript
  67. async function logout() {
  68. // 모든 store 초기화
  69. authStore.setLogout()
  70. setupStore.reset() // Setup syntax
  71. optionsStore.$reset() // Options syntax
  72. // 로컬 스토리지 정리
  73. localStorage.clear()
  74. }
  75. ```
  76. ## API Rules
  77. - api 서버는 코드이그나이터4 베이스의 벡엔드 기술로 구현되어있으며
  78. 기존 문서에사용되는 양식을 지키며 구현
  79. - 프론트에서 api신규 생성시 백엔드 코드이그나4 기반의 기술로 구현하는 예제를 함께 제공
  80. - 항상 페이지 구성이 완료되고 나면 제작에 필요한 쿼리를 DDL형태로 구성해서 ddl폴더에 만들어줘
  81. - api구성후 백엔드 예제를 backend-examples에 코드이그나이터4 형태로 구성해줘
  82. - MD파일을 생성해서 백엔드 구성과 DB생성을 하는 과정을 순서대로 작성해줘
  83. - 프론트화면 및 UI / API 구성시에는 항상 composition api 형태로 작성 css는 항상 scss형태로 분리해서 구성
  84. ## 프론트엔드 API 호출 규칙
  85. - **Nuxt.js server/api 사용 금지**: 프론트엔드에서 직접 백엔드 API 호출
  86. - **useAxios() 패턴 강제**: 기존 코드베이스와 일관성 유지
  87. - 반드시 다음 형태로 구성:
  88. ```javascript
  89. const loadData = async () => {
  90. try {
  91. const params = {
  92. // 파라미터들...
  93. }
  94. useAxios()
  95. .post('/api/endpoint', params)
  96. .then((res) => {
  97. if (res.data.success) {
  98. // 성공 처리
  99. data.value = res.data.data
  100. } else {
  101. // 실패 처리
  102. error.value = res.data.message
  103. }
  104. })
  105. .catch((err) => {
  106. // 에러 처리
  107. error.value = err.message
  108. })
  109. .finally(() => {
  110. // 완료 처리
  111. loading.value = false
  112. })
  113. } catch (err) {
  114. error.value = err.message
  115. }
  116. }
  117. ```
  118. ## API 구조 금지사항
  119. - **server/api 디렉토리 생성 금지**: Nuxt.js 서버 API 사용하지 않음
  120. - **mysql2, 데이터베이스 라이브러리 사용 금지**: 프론트엔드에서 직접 DB 연결 금지
  121. - **$fetch 사용 금지**: useAxios() 패턴만 사용
  122. - **async/await 패턴 지양**: .then().catch().finally() 체인 사용
  123. ## 백엔드 연동 방식
  124. - 프론트엔드 → CodeIgniter4 백엔드 직접 호출
  125. - useAxios()를 통한 HTTP 통신만 사용
  126. - 응답 형태: `res.data.success`, `res.data.data`, `res.data.message`
  127. - 백엔드는 직접 만들거야 다만 너가 backend-examples 폴더에 프론트와 수신할수는있는 형태의 api예제를 만들어
  128. - useAxios()를 통한 HTTP 통신만 사용
  129. - 응답 형태: `res.data.success`, `res.data.data`, `res.data.message`
  130. - 백엔드는 직접 만들거야 다만 너가 backend-examples 폴더에 프론트와 수신할수는있는 형태의 api예제를 만들어