koreainvestment / open-trading-api

Korea Investment & Securities Open API Github https://apiportal.koreainvestment.com
402 stars 115 forks source link

openapi 스팩 json 문서를 공유할 수 있나요? #2

Closed mrchypark closed 2 years ago

mrchypark commented 2 years ago

openapi 스팩 문서를 공유해주시면, 많은 언어에서 클라이언트 패키지를 쉽게 만드는데 사용할 수 있을 것 같습니다.

koreainvestment commented 2 years ago

json 문서가 따로 준비된 사항이 없습니다.

필요하시다면 준비할 수 있도록 검토해보겠습니다.

필요하신 json 형태의 예시가 있으실까요?

mrchypark commented 2 years ago

https://apiportal.koreainvestment.com/apiservice/oauth2#L_214b9e22-8f2e-4fba-9688-587279f1061a

위 링크를 보건데 따로 문서를 어떤 것이든 양식에 맞춰서 생산하신 것으로 이해했습니다. openapi v3이 가장 많이 사용하는 양식으로 저는 이해하고 있구요. 그래서 위 문서를 생성하실 때 어떤 표준 문서 양식을 기준으로 생성하시지 않았을까 가정하였습니다.

openapi는 스펙 작성을 json 형식으로 하기 때문에 문의 드렸습니다. 혹시 어떤 표준 양식을 사용하시지 않고 따로 위에 문서 페이지를 만든 것이시라면 알려주세요.

감사합니다.

koreainvestment commented 2 years ago

따로 위의 문서 페이지를 제작했습니다. 스펙 작성을 json형태로 변환할 수 있을지 검토해보겠습니다.

mrchypark commented 2 years ago

@koreainvestment 이해했습니다. 그 전까지는 포털의 문서를 참고하겠습니다. 저의 질문은 모두 해결되었습니다. 감사합니다.

mrchypark commented 2 years ago

@koreainvestment openapi와 swagger는 같은 말입니다만, 혹시 알고 계신가요? 테스트베트가 swagger로 되어 있길래 추가 질문 드립니다.

image

justinyoo commented 2 years ago

적어도 여기 소스코드를 보면 OpenAPI 문서가 있을 것 같습니다.

https://github.com/koreainvestment/open-trading-api/blob/5bd3c00be14a00ff5d2094cf05e19ba014d656de/rest/kisdev_vi.yaml#L17

koreainvestment commented 2 years ago

감사합니다. 말씀해주신 내용도 준비 중에 있습니다. 완료되면 공지하겠습니다.