search

paust-team / paust-db

GNU General Public License v3.0
6 stars 5 forks source link

Support client cli interface with Library & API #78

Closed elon0823 closed 5 years ago

elon0823 commented 5 years ago

Naming 혼동

현재 paust-db path 안에 client 라는 path 가 존재하고 있는데, 이게 third-party client 라는 느낌이 많이 듭니다. 결국 우리가 만든 client/ 에 있는 모듈들은 cli 환경에서의 interface 의 역할을 하는 cli-client 라고 볼 수 있습니다. 이 cli-client를 라이브러리화 하여 third-party client 샘플을 작성하도록 하는게 좋을 것 같습니다.

즉, 지금 paust-db 에 패키징해서 가져갈 client.go라는 녀석은 cli-client.go 같이 네이밍되서 paust-db로 패키징하여 제공되면되고 해당 패키징과 별개로 타 개발자들이 우리가 만든 cli-interface 혹은 API 를 import 하여 third party client app 을 만들어 볼 수 있도록 client_sample.go 라는 파일을 작성하면서 quick start 에 추가하면 좋을 것 같네요.

dragon0170 commented 5 years ago

https://www.notion.so/3rd-party-client-f41d5ed94698444991dc22eda9a157f8

dragon0170 commented 5 years ago

Working branch

dragon0170 commented 5 years ago

godoc을 위한 주석 작성중