api-rule.mdc 4.4 KB

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