{"id":26036588,"url":"https://github.com/delight-hk3/productmanage-api","last_synced_at":"2026-04-10T11:01:48.112Z","repository":{"id":280911846,"uuid":"943574432","full_name":"delight-HK3/productmanage-API","owner":"delight-HK3","description":"productmanage REST API","archived":false,"fork":false,"pushed_at":"2025-06-19T05:41:44.000Z","size":60,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-19T06:32:13.214Z","etag":null,"topics":["gradle","java-17","mariadb","querydsl","rest-api","spring-boot","spring-data-jpa","vscode"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/delight-HK3.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-03-05T23:38:28.000Z","updated_at":"2025-06-19T05:41:46.000Z","dependencies_parsed_at":"2025-03-06T01:27:51.240Z","dependency_job_id":"6de8338e-d11d-4336-ad9c-de48c3a06606","html_url":"https://github.com/delight-HK3/productmanage-API","commit_stats":null,"previous_names":["delight-hk3/productmanage-api"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/delight-HK3/productmanage-API","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/delight-HK3%2Fproductmanage-API","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/delight-HK3%2Fproductmanage-API/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/delight-HK3%2Fproductmanage-API/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/delight-HK3%2Fproductmanage-API/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/delight-HK3","download_url":"https://codeload.github.com/delight-HK3/productmanage-API/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/delight-HK3%2Fproductmanage-API/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31639524,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-10T07:40:12.752Z","status":"ssl_error","status_checked_at":"2026-04-10T07:40:11.664Z","response_time":98,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["gradle","java-17","mariadb","querydsl","rest-api","spring-boot","spring-data-jpa","vscode"],"created_at":"2025-03-07T07:19:13.558Z","updated_at":"2026-04-10T11:01:48.092Z","avatar_url":"https://github.com/delight-HK3.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# productmanage-Rest-API\n\n### API 명세서\n\n### productmanage-Rest-API\n해당 API는 JPA를 이용한 REST API입니다. 구매가능한 상품 및 전체상품 조회, 장바구니 기능, 주문 및 결제 기능을 제공하고 있습니다, 결제 기능은 beeceptor MOCK API를 사용했습니다.\n\n### 기본정보\n- API 이름 : productmanage-Rest-API\n- 버전 : v1\n- 기본 URL : http://localhost:8088/api/v1\n\n```\nAPI 기술 스택\n\nFramework : Spring boot 3.4.3\nLanguage : Java 17\nDatabase : MariaDB 10.11.11\nORM : Spring Data JPA, QueryDSL\nTool : Visual Studio Code\n```\n\n### 엔드포인트\n(해당 문서의 응답예시는 모두 실제로 존재하지 않는 더미데이터 입니다.)\n\n### 기능별 목록\n- [상품관련 기능](#상품관련-기능)\n- [장바구니 관련 기능](#장바구니-관련-기능)\n- [주문관련 기능](#주문관련-기능)\n- [결제관련 기능](#결제관련-기능)\n- [성공메세지](#성공메세지)\n- [에러메세지](#에러메세지)\n\n\n\n---\n### 상품관련 기능\n\n#### **GET** /product\n- 설명 : 재고가 0개 이상인 판매 가능 상품 목록 조회\n- 요청 파라미터 : 없음\n\n**응답 파라미터**\n| 파라미터 | 타입 | 설명 | \n| --- | --- | --- |\n| id | Long | 상품 고유 번호 | \n| name | String | 상품 이름 |\n| description | String | 상품 설명 | \n| price | Long | 상품 가격 | \n| stock | Long | 상품의 현재 재고 | \n\n응답 예시\n```json\n{\n    \"code\": 200,\n    \"data\": [\n        {\n            \"id\": 1,\n            \"name\": \"사과\",\n            \"description\": \"충주에서 생산한 신선한 사과\",\n            \"price\": 1500,\n            \"stock\": 30\n        },\n        {\n            \"id\": 2,\n            \"name\": \"바나나\",\n            \"description\": \"마다가스카르산 바나나\",\n            \"price\": 5000,\n            \"stock\": 30\n        },\n        {\n            \"id\": 3,\n            \"name\": \"접시\",\n            \"description\": \"이천에서 만든 접시\",\n            \"price\": 9000,\n            \"stock\": 30\n        }\n    ],\n    \"message\": \"successfully get\"\n}\n```\n\n\u003cbr\u003e\n\n#### **GET** /product/{productid}\n- 설명 : 특정 ID의 상품 조회\n- 요청 파라미터 \n    - productid (필수) : 상품 번호 \n\n**응답 파라미터**\n| 파라미터 | 타입 | 설명 | \n| --- | --- | --- |\n| id | Long | 상품 고유 번호 | \n| name | String | 상품 이름 |\n| description | String | 상품 설명 | \n| price | Long | 상품 가격 | \n| stock | Long | 상품의 현재 재고 | \n\n응답 예시\n```json\n{\n    \"code\": 200,\n    \"data\": {\n        \"id\": 1,\n        \"name\": \"사과\",\n        \"description\": \"충주에서 생산한 신선한 사과\",\n        \"price\": 1500,\n        \"stock\": 30\n    },\n    \"message\": \"successfully get\"\n}\n```\n\n\u003cbr\u003e\n\n#### **GET** /products\n- 설명 : 재고량 관계없이 상품 전체 목록 조회\n- 요청 파라미터 : 없음\n\n**응답 파라미터**\n| 파라미터 | 타입 | 설명 | \n| --- | --- | --- |\n| id | Long | 상품 고유 번호 | \n| name | String | 상품 이름 |\n| description | String | 상품 설명 | \n| price | Long | 상품 가격 | \n| stock | Long | 상품의 현재 재고 | \n\n응답 예시\n```json\n{\n    \"code\": 200,\n    \"data\": [\n        {\n            \"id\": 1,\n            \"name\": \"사과\",\n            \"description\": \"충주에서 생산한 신선한 사과\",\n            \"price\": 1500,\n            \"stock\": 30\n        },\n        {\n            \"id\": 2,\n            \"name\": \"바나나\",\n            \"description\": \"마다가스카르산 바나나\",\n            \"price\": 5000,\n            \"stock\": 30\n        },\n        {\n            \"id\": 3,\n            \"name\": \"접시\",\n            \"description\": \"이천에서 만든 접시\",\n            \"price\": 9000,\n            \"stock\": 30\n        },\n        {\n            \"id\": 4,\n            \"name\": \"오렌지\",\n            \"description\": \"플로리다에서 따온 오렌지\",\n            \"price\": 3000,\n            \"stock\": 0\n        }\n    ],\n    \"message\": \"successfully get\"\n}\n```\n[목록으로 이동하기](#기능별-목록)\n\n\u003cbr\u003e\n\n---\n### 장바구니 관련 기능\n\n#### **GET** /cart/{customerid}\n- 설명 : 입력한 고객번호의 장바구니 목록 조회\n- 요청 파라미터 \n   - customerid (필수) : 고객 번호\n\n**응답 파라미터**\n| 파라미터 | 타입 | 설명 | \n| --- | --- | --- |\n| id | Long | 장바구니 고유 번호 | \n| customerName | String | 주문자 이름 |\n| productName| String| 상품이름 | \n| productPrice| Long | 상품 가격 | \n| cartStock| Long | 장바구니에 등록된 재고 | \n| productAllPrice| Long | 상품 전체 가격 | \n\n응답 예시\n```json\n{\n    \"code\": 200,\n    \"data\": [\n        {\n            \"id\": 1,\n            \"customerName\": \"박영희\",\n            \"productName\": \"사과\",\n            \"productPrice\": 1500,\n            \"cartStock\": 10,\n            \"productAllPrice\": 15000\n        }\n    ],\n    \"message\": \"successfully get\"\n}\n```\n\n\u003cbr\u003e\n\n#### **POST** /cart?customerid=[]\u0026productid=[]\u0026stock=[]\n- 설명 : 재고량 관계없이 상품 전체 목록 조회\n- 요청 파라미터 \n   - customerid **(Integer)** : 고객 번호 (필수)\n   - productid **(Integer)** : 상품 번호 (필수)\n   - stock **(Integer)** : 재고 (필수)\n\n응답 예시\n```json\n{\n    \"code\": 201,\n    \"message\": \"successfully post\"\n}\n```\n\n\u003cbr\u003e\n\n#### **PATCH** /cart/{customerid}?cartid=[]\u0026stock=[]\n- 설명 : 장바구니 1건 재고 수정\n- 요청 파라미터 \n   - customerid **(Integer)** : 고객 번호 (필수)\n   - cartid **(Integer)** : 장바구니 번호 (필수)\n   - stock **(Integer)** : 재고 변경값 (필수)\n\n응답 예시\n```json\n{\n    \"code\": 200,\n    \"message\": \"successfully edit\"\n}\n```\n\n\u003cbr\u003e\n\n#### **DELETE** /cart/{customerid}?cartid=[]\n- 설명 : 장바구니 1건 재고 수정\n- 요청 파라미터 \n   - customerid **(Integer)** : 고객 번호 (필수) \n   - cartid **(Integer)** : 장바구니 번호 (필수)\n\n응답 예시\n```json\n{\n    \"code\": 200,\n    \"message\": \"successfully delete\"\n}\n```\n\n[목록으로 이동하기](#기능별-목록)\n\n\u003cbr\u003e\n\n---\n### 주문관련 기능\n\n#### **GET** /order/{customerid}\n- 설명 : 입력한 고객번호의 주문 목록 조회\n- 요청 파라미터 \n   - customerid **(Integer)** : 고객 번호 (필수)\n\n**응답 파라미터**\n| 파라미터 | 타입 | 설명 | \n| --- | --- | --- |\n| orderId | String | 주문 코드 번호 | \n| customerName | String | 주문자 이름 |\n| paymentYn | String | 현재 결제 상태 | \n|  cartList |  \n| id| Long | 장바구니 번호 | \n| productName | String | 상품 이름  | \n| productPrice| Long | 상품 개당 가격 | \n| cartStock| Long | 장바구니에 등록된 재고 | \n| productAllPrice| Long | 상품 전체 가격 | \n\n응답 예시\n```json\n{\n    \"code\": 200,\n    \"data\": [\n        {\n            \"orderId\": \"OD2CA1\",\n            \"customerName\": \"박영희\",\n            \"paymentYn\": \"결제 대기\",\n            \"cartList\": [\n                {\n                    \"id\": 1,\n                    \"productName\": \"사과\",\n                    \"productPrice\": 1500,\n                    \"cartStock\": 10,\n                    \"productAllPrice\": 15000\n                }\n            ]\n        }\n    ],\n    \"message\": \"successfully get\"\n}\n```\n\n\u003cbr\u003e\n\n#### **POST** /order?customerid=[]\n- 설명 : 장바구니의 모든목록을 주문\n- 요청 파라미터 \n   - customerid **(Integer)** : 고객 번호 (필수)\n\n응답 예시\n```json\n{\n    \"code\": 200,\n    \"message\": \"successfully post\"\n}\n```\n[목록으로 이동하기](#기능별-목록)\n\n\u003cbr\u003e\n\n---\n### 결제관련 기능\n\n#### **GET** /payment/{customerid}\n- 설명 : 특정 고객의 결제 내역을 조회\n- 요청 파라미터 \n   - customerid **(Integer)** : 고객 번호 (필수)\n\n**응답 파라미터**\n| 파라미터 | 타입 | 설명 | \n| --- | --- | --- |\n| id | Long | 결제 번호 | \n| name| String | 고객 이름 | \n| orderCode | String | 주문 코드 번호 | \n| amount| Long | 지불한 금액 | \n| successYn| String | 결제시도 후 성공 여부 | \n| failReason | String | 결제 실패시 원인 메세지 (결제 성공시 null / 결제 실패시 원인 출력) | \n| createDt| LocalDateTime | 결제 시도 시간 | \n\n응답 예시\n```json\n{\n    \"code\": 200,\n    \"data\": [\n        {\n            \"id\": 1,\n            \"name\": \"박영희\",\n            \"orderCode\": \"OD2CA1\",\n            \"amount\": 20000,\n            \"successYn\": \"결제 성공\",\n            \"failReason\": null,\n            \"createDt\": \"2025-03-01T21:02:45.500368\"\n        }\n    ],\n    \"message\": \"successfully get\"\n}\n```\n\n\u003cbr\u003e\n\n#### **POST** /payment?customerid=[]?orderid=[]\u0026amount=[]\n- 설명 : 주문목록의 특정 주문을 외부 결제 API를 통해 결제\n- 요청 파라미터 \n   - customerid **(Integer)** : 고객 번호 (필수)\n   - orderid **(String)** : 주문 코드 번호 (필수)\n   - amount **(Integer)** : 지불한 금액 (필수)\n   \n응답 예시\n```json\n{\n    \"code\": 200,\n    \"message\": \"successfully post\"\n}\n```\n\n\n[목록으로 이동하기](#기능별-목록)\n\n\u003cbr\u003e\n\u003cbr\u003e\n\n### 성공메세지\nAPI에 요청을 하여 정상적으로 완료되면 다음과 같은 응답을 받습니다.\n\n| HTTP STATUS | 코드 | 메세지 | 설명 |\n| --- | --- | --- | --- |\n| OK | 200 | successfully get | 상품조회 및 장바구니 조회등 조회 관련 요청 후 성공하면 출력되는 메세지입니다. |\n| CREATED | 201 | successfully post | 장바구니 물건 생성 및 주문생성등 생성 관련 요청 후 완료되면 출력되는 메세지입니다. |\n| OK | 200 | successfully edit | 장바구니 물건 재고 수정 및 수정 관련 요청 후 완료되면 출력되는 메세지입니다. |\n| OK | 200 | successfully delete | 장바구니 내용 삭제 등 삭제 관련 요청 후 완료되면 출력되는 메세지입니다.  |\n\n[목록으로 이동하기](#기능별-목록)\n\n\u003cbr\u003e\n\n### 에러메세지\n\n클라이언트 요청 관련 오류 응답메세지\n| HTTP STATUS | 코드 | 메세지 | 설명 |\n| --- | --- | --- | --- |\n| BAD_REQUEST | 400 | A required parameter is missing. | 필수 파라미터가 누락되는 경우 출력되는 메세지입니다. |\n| BAD_REQUEST | 400 | The parameter type is incorrect. | 파라미터를 명시된 타입 이외의 타입을 입력한 경우에 출력되는 메세지입니다. |\n| NOT_FOUND | 404 | The request does not exist. | 존재하지 않는 요청을 보냈을 때 출력되는 메세지입니다. |\n| METHOD_NOT_ALLOWED | 405 | This method is not allowed. | API 문서와 다른 HTTP 타입으로 요청했을 때 출력되는 메세지입니다. |\n\n상품관련 오류 응답메세지\n| HTTP STATUS | 코드 | 메세지 | 설명 |\n| --- | --- | --- | --- |\n| NOT_FOUND | 404 | This product does not exist. | 특정 상품번호로 검색했을 때 결과가 없는 경우 출력되는 메세지입니다. | \n| NOT_FOUND | 404 | A required parameter is missing. | 필수 파라미터가 누락되는 경우 출력되는 메세지입니다. |\n| NOT_FOUND | 404 | There are currently no products available for purchase. | 재고가 충분한 상품중에 구매 가능한 상품이 없는경우 출력되는 메세지입니다. | \n\n고객관련 오류 응답메세지\n| HTTP STATUS | 코드 | 메세지 | 설명 |\n| --- | --- | --- | --- |\n| NOT_FOUND | 404 | This customer does not exist. | 고객 번호를 파라미터로 요청 후 결과가 없는 경우 출력되는 메세지입니다. |\n \n장바구니 관련 오류 응답메세지\n| HTTP STATUS | 코드 | 메세지 | 설명 |\n| --- | --- | --- | --- |\n| NOT_FOUND | 404 | There is not enough stock. | 기존 상품의 재고보다 많은 재고를 요청한 경우 출력되는 메세지입니다. |\n| NOT_FOUND | 404 | There are no items in your shopping cart. | 장바구니에 물건이 존재하지 않는경우 출력되는 메세지입니다. |\n| NOT_FOUND | 404 | The product does not exist in your shopping cart. | 장바구니의 상품중 상품목록에 없는 상품이 등록되어있는 경우에 출력되는 메세지입니다. |\n\n주문관련 오류 응답메세지\n| HTTP STATUS | 코드 | 메세지 | 설명 |\n| --- | --- | --- | --- |\n| NOT_FOUND | 404 | The order list does not exist. | 주문목록이 존재하지 않는경우 출력되는 메세지입니다. |\n| NOT_FOUND | 404 | All items in your cart are out of stock. | 장바구니의 모든상품이 재고량을 초과하는 경우출력되는 메세지입니다. |\n\n결제관련 오류 응답메세지\n| HTTP STATUS | 코드 | 메세지 | 설명 |\n| --- | --- | --- | --- |\n| NOT_FOUND | 404 | The payment list does not exist. | 결제목록이 존재하지 않는경우 출력되는 메세지입니다. |\n| NOT_FOUND | 404 | This order has already been paid. | 이미 결재가 마친 주문인 경우 출력되는 메세지입니다. |\n| NOT_FOUND | 404 | The amount you paid is not enough. | 결제시 입력한 금액이 주문금액보다 작으면 출력되는 메세지입니다. |\n| NOT_FOUND | 404 | There are no orders matching your order number. | 주문번호와 일치하는 주문이 없는 경우 출력되는 메세지입니다. |\n\n[목록으로 이동하기](#기능별-목록)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdelight-hk3%2Fproductmanage-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdelight-hk3%2Fproductmanage-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdelight-hk3%2Fproductmanage-api/lists"}