연습 - GitHub Copilot을 사용하여 Python Web API 업데이트
GitHub Copilot의 추천 코드를 사용하여 Python 리포지토리를 수정해 대화형 HTML 양식과 API(애플리케이션 프로그래밍 인터페이스) 엔드포인트를 만드는 방법을 살펴보겠습니다. 이 리포지토리를 사용하여 일반적으로 식별 루틴에 사용되는 의사 난수 토큰을 생성하는 HTTP API를 제공하는 Python 웹앱과 관련된 실습 경험을 빠르게 쌓을 수 있습니다.
API란?
API는 서로 다른 애플리케이션이 서로 통신할 수 있도록 하는 중개자 역할을 합니다. 예를 들어 날씨 웹 사이트는 과거 데이터를 공유하거나 API를 통해 예측 기능을 제공할 수 있습니다. API를 사용하여 웹 사이트에 데이터를 포함하거나 날씨 데이터를 다른 기능과 공유하는 애플리케이션을 만들 수 있습니다.
Web API 확장
API에는 토큰을 생성하는 단일 엔드포인트가 이미 있습니다. 텍스트를 받고 토큰 목록을 반환하는 새 엔드포인트를 추가하여 API를 업데이트해 보겠습니다.
참고 항목
이 연습에서는 브라우저에서 사전 구성된 환경이 포함된 Codespace를 사용합니다.
1단계: Pydantic 모델 추가
main.py 파일로 이동하여 GitHub Copilot에서 Pydantic 모델을 생성할 수 있도록 주석을 추가합니다. 생성된 모델은 이 예제와 같습니다.
class Text(BaseModel):
text: str
2단계: 새 엔드포인트 생성
다음으로 GitHub Copilot에서 주석을 추가하여 새 엔드포인트를 생성합니다.
# Create a FastAPI endpoint that accepts a POST request with a JSON body containing a single field called "text" and returns a checksum of the text
3단계: 필요한 가져오기 추가
생성된 코드는 base64 및 os 모듈을 가져오지 않으면 애플리케이션이 충돌할 수 있습니다. GitHub Copilot 채팅을 사용하여 누락된 가져오기를 추가할 수 있도록 Copilot에 요청합니다.
또는 파일 상단에 다음 줄을 추가합니다.
import base64
import os
마지막으로 새 엔드포인트가 작동하는지 확인합니다.
/docs 엔드포인트로 이동하여 엔드포인트가 표시되는지 확인해 보세요.
축하합니다. 이 연습을 통해 Copilot을 사용하여 대화형의 재미있는 방식으로 코드를 생성했습니다. GitHub Copilot을 사용하여 코드를 생성하고, 문서를 작성하고, 애플리케이션을 테스트하는 등 다양한 작업을 할 수 있습니다.
GitHub에서 연습이 끝나면 여기로 돌아와서 다음을 수행하세요.
- 빠른 지식 점검
- 학습한 내용 요약
- 이 모듈 완료 배지