robincloud / openapi

Cloud based Server application for Open API service.

Robin OpenAPI

Open API server application for Robin Service.

Environment (환경)

The required Basic Development Environment (개발 및 실행 환경에 대해서 설명).

• NodeJS + Express : 설치 참고 문서 링크
• AWS 환경
  • Credentials : 설정 참고 문서 링크
  • DynamoDB : 로컬 설치 참고 문서 링크
  • Elasticache : memcached 엔진 설정 필요. 설정 참고 문서 링크
  • SES(Simple Email Service) : 이메일 발송 권한 필요. 설정 참고 문서 링크

Installation (설치)

How to install development server environment locally (개발 환경 설치 및 운영에 대한 설명서).

$ git clone https://github.com/robincloud/openapi
$ cd openapi
$ npm install
$ npm start

# 로컬 개발 환경에서는 다음과 같은 주소로 접속 가능.
# open browser 'http://localhost:8081'

Deploy (배포)

How to deploy to cloud service

ex) AWS Beanstalk

$ git glone [e-mail]:robincloud/openapi.git
$ pip install awsebcli --upgrade --user
$ eb create
Enter Environment Name
(default is eb-dev): openapi
Enter DNS CNAME prefix
(default is eb-dev): openapi
WARNING: The current directory does not contain any source code. Elastic Beanstalk is launching the sample application instead.
Environment details for: elasticBeanstalkExa-env
  Application name: elastic-beanstalk-example
  Region: us-west-2
  Deployed Version: Sample Application
  Environment ID: e-j3pmc8tscn
  Platform: 64bit Amazon Linux 2015.03 v1.4.3 running Docker 1.6.2
  Tier: WebServer-Standard
  CNAME: openapi.elasticbeanstalk.com
  Updated: 2017-06-27 01:02:24.813000+00:00
Printing Status:
INFO: createEnvironment is starting.
 -- Events -- (safe to Ctrl+C) Use "eb abort" to cancel the command.
$ eb deploy

Document (문서)

깃허브 위키 문서 wiki

API specification (API 스펙 문서)

상세 API 문서: swagger-ui

Live Operation (운영환경)

운영서버: robin-api

Test Data (테스트 데이터)

테스트 데이터: testset

Slack Workspace (커뮤니티 환경)

슬랙: http://robincloud.slack.com

---

Database Schema (디비 스키마)

데이터베이스용 테이블의 스키마 정의.

items (기본 상품 테이블)

비교 상품군을 저장하는 테이블.

필드명	타입	설명
id	string(64)	<sid>_<pid>_<oid> 형태로 구성 sid: shop-id 쇼핑몰별 고유아이디 (네이버쇼핑일 경우 nv) pid: product-id 제품 ID oid: *option-id 옵션ID값으로 선택사항 자세한 내용은 아래 참고.
sid	string(32)	쇼핑몰별 고유아이디(네이버쇼핑의 경우 nv)
name	string	상품 이름
option	string	옵션 이름 (선택 사항. oid가 있을 경우)
image	url	상품 대표 이미지
malls	array	연관된 메타 상품의 리스트로, malls.id 를 리스트로 저장함.
refId	string	참조되는 items.id의 연결 값.
vector	array	상품의 10차원 벡터값.
*cat	string	카테고리
*maker	string	제조사
*brand	string	브랜드.

* 필수 항목이 아닌 선택 입력 사항.

malls (메타 상품 테이블)

메타 상품을 저장하는 테이블.

필드명	타입	설명
id	string(64)	<sid>_<pid>_<oid> 형태로 구성.
sid	string(32)	쇼핑몰별 고유아이디(네이버쇼핑의 경우 nv)
name	string	상품 판매 이름
option	string	옵션 이름 (선택 사항. oid가 있을 경우)
image	url	상품 판매 대표 이미지
price	number	판매가
delivery	number	배송비
invalid	boolean	판매 여부.

TBD