Bài tập - Cập nhật API web với GitHub Copilot
Hãy khám phá cách bạn có thể sửa đổi kho lưu trữ Python bằng các kỹ thuật nâng cao GitHub Copilot cho điểm cuối API. Có được nhiều kinh nghiệm thực tế hơn bằng cách sử dụng kho chứa ứng dụng Python Web lưu trữ API Thời tiết Du lịch.
API là gì?
API hoạt động như trung gian cho phép các ứng dụng khác nhau giao tiếp với nhau. Ví dụ: một trang web thời tiết có thể chia sẻ dữ liệu lịch sử hoặc cung cấp chức năng dự báo thông qua API của nó. Sử dụng API, bạn có thể nhúng dữ liệu vào trang web của mình hoặc tạo một ứng dụng chia sẻ dữ liệu thời tiết với các tính năng khác.
Mở rộng API Web
API hiện tại không hiển thị quốc gia/khu vực, cần được triển khai để liệt kê các thành phố. Tuyến chỉ nên cho phép các yêu cầu HTTP GET với phản hồi JSON cung cấp thông tin từ mức cao và thấp trong lịch sử cho quốc gia/khu vực, thành phố và tháng nhất định đó.
Ghi
Đối với bài tập này, hãy sử Codespace với môi trường được cấu hình sẵn trình duyệt của bạn.
Bước 1: Thêm tuyến đường mới
Mở tệp main.py và sử dụng trò chuyện nội tuyến với lệnh Ctrl+i (trên Windows) hoặc Command+i (trên máy Mac). Lệnh này yêu cầu GitHub Copilot giúp bạn tạo một API mới hiển thị cho bạn các thành phố của một quốc gia/khu vực. Sử dụng lời nhắc sau:
Create a new route that exposes the cities of a country/region.
Lời nhắc này sẽ cung cấp cho bạn nội dung tương tự như sau:
# Create a new route that exposes the cities of a country:
@app.get('/countries/{country}')
def cities(country: str):
return list(data[country].keys())
Ghi
Hãy thử tuyến đường mới của bạn và tinh chỉnh lời nhắc cho đến khi kết quả như mong muốn.
Bước 2: Tạo bài kiểm tra
Bây giờ bạn đã tạo một tuyến đường mới, hãy tạo thử nghiệm với Copilot Chat cho tuyến đường này sử dụng Tây Ban Nha làm quốc gia/khu vực. Hãy nhớ chọn mã của bạn và yêu cầu Trò chuyện Copilot giúp bạn với API cụ thể này mà chúng tôi vừa tạo. Bạn có thể sử dụng tính năng trò chuyện nội tuyến hoặc ngăn trò chuyện chuyên dụng với lời nhắc sau:
/tests help me to create a new test for this route that uses Spain as the country/region.
Sau khi Copilot giúp bạn tạo thử nghiệm, hãy thử. Nếu điều này không hoạt động như mong đợi, vui lòng chia sẻ những chi tiết này với Copilot trong cuộc trò chuyện. Chẳng hạn:
This test is not quite right, it is not including cities that doesn't exist. Only Seville is part of the API.
Bước 3: Sử dụng nhân viên để viết tài liệu
Cuối cùng, hãy sử dụng @workspace lý để viết tài liệu dự án và chi tiết về cách chạy chính dự án đó. Mở tệp README.md và sử dụng lời nhắc sau đây trong Trò chuyện GitHub Copilot:
@workspace I want to document how to run this project so that other developers can get started quickly by reading the README.md file.
Bạn sẽ nhận được phản hồi giúp bạn cập nhật tệp README.md với thông tin cần thiết để chạy dự án.
Chúc mừng bạn đã hoàn thành bài tập này. Bạn đã sử dụng GitHub Copilot để tạo một định tuyến API mới, sau đó viết một thử nghiệm để xác minh tính chính xác của nó. Cuối cùng, bạn đã thêm tài liệu bằng cách sử dụng một đại diện sẽ giúp các nhà phát triển hiểu cách chạy dự án này.
Khi bạn đã hoàn thành bài tập ở GitHub, hãy quay lại đây cho:
- Kiểm tra kiến thức nhanh
- Một bản tóm tắt những gì bạn đã học được
- Huy hiệu để hoàn thành mô-đun này