재생성이 사람이 채운 서술과 이전 실측 결과를 지우고, 코드가 바뀌지 않은 문서까지 매 실행마다 흔들던 결함 5건을 고쳤다. - 중첩 객체 파라미터가 문서에서 통째로 누락되던 문제: 배열 요소(items.*.id)를 상위로 대표시키려던 스킵 조건이 점(.) 포함 여부만 봐서, 와일드카드가 없는 중첩 객체 필드(refund_bank.*, general.*, content.* 등 17개 엔드포인트 수백 개) 까지 함께 버렸다. 와일드카드가 있을 때만 스킵하도록 좁혔다. - 사람이 보강한 에러 응답 표가 자동 추론 초안에 덮여 사라지던 문제: 상태코드 키 단위로 병합한다. - 실측 실패가 이전에 관측해 둔 응답 예시를 지우던 문제: 실측 성패는 호출 시점 데이터 유무에 좌우되므로(DELETE /checkout 은 대상이 없으면 404), 실패는 "새로 관측하지 못했다"는 뜻이지 기존 관측이 무효라는 뜻이 아니다. - 실측 예시값·응답 예시 JSON 이 DB 상태를 그대로 반영해 비멱등하던 문제: 값이 아니라 스펙(필드 집합·타입)이 바뀐 경우에만 갱신한다. nullable 이 null 로 관측된 것은 타입 변경이 아니므로 기존 값을 유지한다. - 요청 예시 path 파라미터가 실측 성패에 따라 흔들리던 문제: placeholder 로 고정. 결과: 문서 63개 전수 대조에서 손실 0(서술·표 셀·응답 예시), 전 scope 연속 재생성 시 diff 0(멱등).
API 레퍼런스 문서 목차
소유: 모듈
sirsoft-ecommerce· 생성:php artisan api:docgen(실측 기반). 아래 표는 자동 생성됩니다. 각 문서를 열면 엔드포인트별 파라미터·응답·예시를 볼 수 있습니다.
- 문서 수: 33 · 엔드포인트 수: 239
| 문서 | 도메인 | 엔드포인트 |
|---|---|---|
| addresses.md | addresses |
6 |
| brands.md | brands |
6 |
| cart.md | cart |
11 |
| categories.md | categories |
14 |
| category-image.md | category-image |
1 |
| checkout.md | checkout |
5 |
| claim-reasons.md | claim-reasons |
8 |
| coupons.md | coupons |
4 |
| currency.md | currency |
2 |
| dashboard.md | dashboard |
4 |
| extra-fee-templates.md | extra-fee-templates |
10 |
| guest.md | guest |
7 |
| inquiries.md | inquiries |
10 |
| mileage.md | mileage |
3 |
| mileage-transactions.md | mileage-transactions |
5 |
| options.md | options |
3 |
| orders.md | orders |
27 |
| payments.md | payments |
1 |
| presets.md | presets |
4 |
| product-common-infos.md | product-common-infos |
6 |
| product-image.md | product-image |
1 |
| product-labels.md | product-labels |
6 |
| product-notice-templates.md | product-notice-templates |
7 |
| products.md | products |
31 |
| promotion-coupons.md | promotion-coupons |
9 |
| review-image.md | review-image |
1 |
| reviews.md | reviews |
12 |
| settings.md | settings |
10 |
| shipping-carriers.md | shipping-carriers |
7 |
| shipping-country.md | shipping-country |
2 |
| shipping-policies.md | shipping-policies |
11 |
| users.md | users |
2 |
| wishlist.md | wishlist |
3 |