라이브러리 코드 개발 사례: ChatGPT를 활용해 API문서로 라이브러리 코드 작성 하기
오늘은 개발자를 위한 ChatGPT 활용법중 하나인 'API 연동 라이브러리 작성'하는 방법을 정리를 해보았습니다.
실무에서 많이 활용 할수 있는 사례이니 활용해보시고 도움이 되셨으면 좋겠습니다.
준비를 위해서는 프롬프트를 시작 하기전에 아래와 같이 ChatGPT가 코드에 대한 조언을 잘 해줄수 있도록 설정 합니다.
act as an experienced developer and advisor for developer
그리고 다음과 같이 라이브러리 코드를 작성할때 신경써야할 요구 사항을 정리하여 코드를 작성 해달라고 요청 해봅니다. 저는 아래 네 가지를 요구 사항으로 요청 했습니다.
- password, credential, api_key 등 민감한 값은 환경 변수로 설정할 수 있도록 작성 할 것
- 예외 처리를 꼭 포함 할것
- test code도 함께 작성 해줄 것
- don't use print() function, use logging module instead
아래에 요청한 프롬프트 입니다.
아래 url 의 Chat Completions API 를 참고 해서 chatgpt api의 python module code 를 작성 해줘
https://platform.openai.com/docs/api-reference/chat/create
[요구사항]
password, credential, api_key 등 민감한 값은 환경 변수로 설정할 수 있도록 작성 할것
예외 처리를 꼭 포함 할것
test code도 함께 작성 해줄것
결과는 아래와 같이 코드 작성을 요청하고 예시 코드도 같이 작성을 해줍니다.
라이브러리 코드 작성 결과
예시 코드도 같이 작성 결과
테스트 코드 작성 결과
위와 같이 ChatGPT를 활용하여 API 문서를 기반으로 테스트 코드 까지 포함한 라이브러리 코드를 작성 해보았는데요 개선해야할 부분이 있지만 기본적으로 동작 하는 코드들은 작성을 잘 해주었습니다.
그리고 위의 예시는 ChatGPT WebPilot이란 플러그인을 활용 하였는데 아래와 같이 개발문서 사양이나 예제 코드를 주고 코드 작성을 요청 할 수 도 있습니다.
아래 [요구사항]과 [개발문서내용]을 참고 해서 chatgpt api의 python module code 를 작성 해줘
[요구사항]
password, credential, api_key 등 민감한 값은 환경 변수로 설정할 수 있도록 작성 할것
예외 처리를 꼭 포함 할것
test code도 함께 작성 해줄것
[개발문서내용]
curl https://api.openai.com/v1/chat/completions \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $OPENAI_API_KEY" \ -d '{ "model": "gpt-3.5-turbo", "messages": [{"role": "user", "content": "Hello!"}] }' Parameters { "model": "gpt-3.5-turbo", "messages": [{"role": "user", "content": "Hello!"}] } Response { "id": "chatcmpl-123", "object": "chat.completion", "created": 1677652288, "choices": [{ "index": 0, "message": { "role": "assistant", "content": "\n\nHello there, how may I assist you today?", }, "finish_reason": "stop" }], "usage": { "prompt_tokens": 9, "completion_tokens": 12, "total_tokens": 21 } }
지금까지 ChatGPT를 활용해 API문서로 라이브러리 코드 작성하는 방법에 대해 알아봤는데요 업무하면서 API연동을 해야할 일이 많다보니 실무에 많이 도움될수 있다는 생각이 들었습니다.