Programowanie w parze z AI z IBM Bob

Uruchom IBM Bob

Uruchom IBM Bob IDE.

Otwórz interfejs czatu Boba

Jeśli interfejs czatu Boba nie jest widoczny, otwórz go, wybierając ikonę Boba obok paska nawigacyjnego. Możesz też nacisnąć Option + Command + B na Macu lub Ctrl + Alt + B na Windows i Linux.

Otwórz pusty folder projektu

Utwórz pusty folder o nazwie todo-api, a następnie otwórz go w Bobie za pomocą File > Open Folder. Jeśli Bob zapyta, czy ufasz autorom plików w tym folderze, wybierz Yes, I trust the authors.

Bob zapisuje wygenerowaną aplikację w tym folderze. Do tego samouczka nie potrzebujesz istniejącego repozytorium.

Wyłącz automatyczne zatwierdzanie

Otwórz Permissions i upewnij się, że automatyczne zatwierdzanie jest wyłączone. Gdy automatyczne zatwierdzanie jest wyłączone, Bob prosi o twoje pozwolenie przed odczytem plików, edycją plików lub uruchamianiem poleceń. Pozostajesz w kontroli nad każdą zmianą w tym samouczku.

Przejdź do trybu Plan

Otwórz menu rozwijane trybów na dole paska bocznego Boba i wybierz Plan.

Tryby stosują zasadę najmniejszych uprawnień. W trybie Plan Bob odczytuje twój kod i tworzy plan w formacie Markdown. Bob nie uruchamia poleceń ani nie wprowadza zmian implementacyjnych. Przeglądasz podejście zanim Bob napisze jakikolwiek kod aplikacji.

Zdefiniuj wymagania aplikacji

W interfejsie czatu Boba wpisz następujący prompt:

Create a simple FastAPI To-Do API.

Requirements:

- Store tasks in a Python list.
- Each task should contain:
    - id
    - task_name

Implement these endpoints with explicit HTTP status codes:

- GET /tasks: list all tasks. Return 200.
- POST /tasks: create a task from a JSON body containing only task_name. Return 201 with the created task.
- DELETE /tasks/{task_id}: delete a task. Return 204 on success and 404 if no task has that id.

Use FastAPI and Pydantic. Use Pydantic model validation so an invalid request body returns 422.

Include a requirements.txt and a Dockerfile. The Dockerfile must start Uvicorn bound to 0.0.0.0 on port 8000 so the API is reachable through a published container port.

Save the plan as Markdown files in a folder named `plans`.

Put the FastAPI application in a single file named `main.py` at the project root.

Keep the implementation simple.

Don't install any dependencies locally or run local tests. Everything will run in a Docker container.

Aby zbudować plan, Bob uruchamia swoją skill planowania. Gdy zostaniesz o to poproszony, wybierz Approve skill tools for task i Approve subagent tools for task, aby Bob mógł zbadać workspace i przygotować plan.

Doprecyzuj plan

Możesz zmienić plan zanim Bob napisze jakikolwiek kod. W interfejsie czatu Boba wpisz następujący prompt uzupełniający:

Update the plan to reject a task whose task_name is empty or longer than 200 characters.

Bob modyfikuje plan, aby uwzględnić dodatkową walidację danych wejściowych. Przejrzyj zaktualizowany plan.

Przejrzyj plan

Bob prezentuje uporządkowany plan i może zapisać go jako plik Markdown w projekcie. Przejrzyj go przed kontynuowaniem:

• Zakres: plan obejmuje każdy endpoint i regułę walidacji, którą dodałeś, i nic, o co nie prosiłeś.
• Nazwane pliki: każdy krok wskazuje plik, który tworzy lub zmienia.
• Niejasny język: frazy takie jak „handle errors appropriately" ukrywają założenia. Poproś Boba o doprecyzowanie.

Pozostajesz odpowiedzialny za te decyzje projektowe. Bob nie implementuje niczego dopóki nie przełączysz się na tryb Agent w sekcji Wygeneruj i przejrzyj aplikację.

Rozpocznij nowe okno kontekstowe

Wybierz New task w polu czatu lub + na górze panelu czatu, aby rozpocząć nowe okno kontekstowe. Zapoznaj się z Create a new context window w celu uzyskania szczegółów. Bob zapisał plan w folderze plans, więc nie potrzebujesz już rozmowy planistycznej w kontekście. Czysty kontekst koncentruje implementację na zatwierdzonym planie.

Przejdź do trybu Agent i uruchom plan

Otwórz menu rozwijane trybów na dole paska bocznego Boba i wybierz Agent. Następnie powiedz Bobowi, żeby zaimplementował plan:

Implement the plan in the plans folder.
@plans/

Tryb Agent pozwala Bobowi zapisywać pliki i uruchamiać polecenia. Bob prosi o zatwierdzenie przed każdą zmianą, ponieważ wyłączyłeś automatyczne zatwierdzanie. Zatwierdzaj kolejne kroki, gdy Bob realizuje plan.

Przejrzyj wygenerowaną aplikację

Gdy implementacja jest gotowa, przejrzyj wygenerowany kod. Ponieważ dane wyjściowe Boba mają charakter probabilistyczny, styl kodu i wewnętrzne nazwy mogą różnić się od przykładów pokazanych tutaj. Aplikacja składa się z następujących części.

Modele danych. Bob generuje dwa modele Pydantic: jeden dla ciała żądania przy tworzeniu zadania i jeden dla przechowywanego zadania. Model tworzenia wymusza regułę długości, którą dodałeś podczas planowania:

class TaskCreate(BaseModel):
    task_name: Annotated[str, Field(min_length=1, max_length=200)]


class Task(BaseModel):
    id: int
    task_name: str

Ścieżki endpointów i kody statusu odpowiadają wymaganiom, które podałeś Bobowi, ale nazwy klas modeli i układ plików mogą się różnić. Ten samouczek zakłada modele Task i TaskCreate. Dostosuj kolejne prompty, jeśli Bob wybrał inne nazwy.

In-memory data store. Bob przechowuje zadania w pustej liście Pythona i przypisuje każdemu nowemu zadaniu rosnące id:

tasks: list[dict] = []
id_counter = 0

Operacje API. Aplikacja udostępnia następujące endpointy:

• GET /tasks
• POST /tasks
• DELETE /tasks/{task_id}

POST /tasks przyjmuje tylko task_name w ciele żądania i zwraca 201 z utworzonym zadaniem. DELETE /tasks/{task_id} zwraca 204 w przypadku powodzenia i 404, gdy żadne zadanie nie ma podanego task_id.

Zależności. Bob generuje plik requirements.txt zawierający FastAPI, Uvicorn i Pydantic.

Kontener. Bob generuje Dockerfile, który instaluje zależności i uruchamia API na porcie 8000 z Uvicornem.

Kontrakt HTTP odpowiada promptowi z wymaganiami, w tym metodom, ścieżkom i kodom statusu. Poniższe kroki weryfikacji mają zastosowanie w takiej formie, w jakiej są napisane.

Otwórz plik aplikacji

Otwórz plik main.py wygenerowany przez Boba i umieść kursor w pustym wierszu na końcu pliku, po ostatnim handlerze route.

Aktywuj tryb literate coding

Naciśnij Command + I na Macu lub Ctrl + I na Windows i Linux. Możesz też wybrać ikonę różdżki na pasku narzędzi edytora.

Napisz instrukcję

Wpisz następującą instrukcję w pustym wierszu. Wyświetla się ona podświetlona innym kolorem niż reszta kodu.

Add a PUT /tasks/{task_id} endpoint that updates the task_name of an existing task, matching the style and conventions of the existing routes. Return 200 with the updated task, or 404 if no task has that id.

Bob wywnioskuje nazwę parametru, model żądania i obsługę błędów z otaczającego kodu, więc podajesz tylko metodę i ścieżkę.

Wygeneruj i zaakceptuj kod

Kliknij Generate lub naciśnij Command + Enter na Macu albo Ctrl + Enter na Windows i Linux. Bob zastępuje twoją instrukcję implementacją i pokazuje diff inline.

Przejrzyj diff, a następnie kliknij Accept All, aby zastosować zmianę. Naciśnij ponownie Command + I na Macu lub Ctrl + I na Windows i Linux, aby wyjść z trybu literate coding.

Poproś Boba o wyjaśnienie kodu

Rozpocznij nowe okno kontekstowe za pomocą New task, a następnie wybierz Ask z menu trybów. Tryb Ask odpowiada na pytania i analizuje kod bez edytowania plików. Używaj go, gdy chcesz wyjaśnienia bez wprowadzania zmian.

Rozumienie wygenerowanego kodu jest ważną częścią programowania w parze z AI. Zapytaj Boba:

Explain the generated To-Do API.

Bob może wyjaśnić architekturę aplikacji, przepływ danych, komponenty FastAPI, modele Pydantic, zachowanie endpointów i decyzje projektowe. Użyj wyjaśnienia, aby potwierdzić, że kod robi to, czego oczekujesz, zanim go zmienisz lub rozszerzysz.

Uruchom aplikację

Przełącz się z powrotem na tryb Agent, aby Bob mógł uruchamiać polecenia. Poproś Boba o zbudowanie i uruchomienie API w kontenerze:

Build the Docker image and run the container with port 8000 mapped to the host. Confirm the API is reachable.

Bob uruchamia polecenia build i start i raportuje, gdy kontener działa.

Otwórz http://localhost:8000/docs w przeglądarce.

FastAPI udostępnia interaktywny Swagger UI pod adresem /docs. Użyj go, aby eksplorować każdy endpoint, sprawdzać schematy żądań i odpowiedzi oraz wykonywać wywołania API z poziomu przeglądarki.

Zweryfikuj API

Użyj Swagger UI pod adresem /docs, aby przetestować każdą operację. Dla każdego endpointu:

1. Rozwiń jego wiersz i kliknij Try it out.
2. Wpisz parametry ścieżki lub ciało żądania.
3. Kliknij Execute.
4. Sprawdź kod i treść Server response.

Dodaj zadanie

1. Rozwiń POST /tasks i kliknij Try it out.

2. Zastąp ciało żądania następującym:

   {
     "task_name": "My first API item!"
   }

3. Kliknij Execute. Upewnij się, że kod odpowiedzi to 201, a treść odpowiedzi pokazuje utworzone zadanie z przypisanym id.

Pobierz zadania

1. Rozwiń GET /tasks i kliknij Try it out.
2. Kliknij Execute. Upewnij się, że kod odpowiedzi to 200, a treść odpowiedzi zawiera zadanie My first API item! z id przypisanym podczas dodawania.

Zaktualizuj zadanie

1. Rozwiń PUT /tasks/{task_id} i kliknij Try it out.

2. Wpisz task_id zadania, które utworzyłeś.

3. Zastąp ciało żądania następującym:

   {
     "task_name": "Build and ship a To-Do API"
   }

4. Kliknij Execute. Upewnij się, że kod odpowiedzi to 200, a zwrócone zadanie pokazuje zaktualizowaną wartość task_name.

5. Zmień task_id na nieistniejącą wartość i ponownie kliknij Execute. Upewnij się, że kod odpowiedzi to 404.

Usuń zadanie

1. Rozwiń DELETE /tasks/{task_id} i kliknij Try it out.
2. Wpisz task_id zadania, które utworzyłeś, i kliknij Execute. Upewnij się, że kod odpowiedzi to 204.
3. Rozwiń GET /tasks, kliknij Execute i upewnij się, że zadanie nie pojawia się już w odpowiedzi.
4. Rozwiń ponownie DELETE /tasks/{task_id}, wpisz ten sam task_id i kliknij Execute. Upewnij się, że kod odpowiedzi to 404.

Implementacja spełnia pierwotne wymagania — w tym endpoint aktualizacji dodany za pomocą literate coding.

Poproś Boba o sugestie poprawek

Rozpocznij nowe okno kontekstowe za pomocą New task, a następnie wpisz:

Review the To-Do API and suggest improvements to code quality, error handling, and HTTP status codes.

Bob identyfikuje braki, takie jak brakujący endpoint do pobrania pojedynczego zadania, in-memory store przechowujący zwykłe słowniki zamiast zwalidowanych modeli Task oraz id_counter na poziomie modułu, który trudno zresetować lub przetestować.

Zastosuj poprawki

Poproś Boba o zaimplementowanie sugestii, które chcesz zachować:

Add a GET /tasks/{task_id} endpoint that returns 404 when the task ID does not exist, and store tasks as Task models instead of dictionaries.

Przejrzyj proponowane zmiany i zatwierdź ich zastosowanie. Poproś Boba o przebudowanie obrazu i ponowne uruchomienie kontenera, a następnie powtórz kroki weryfikacji. Upewnij się, że GET /tasks/{task_id} zwraca 200 z zadaniem dla prawidłowego ID i 404 dla nieznanego ID, oraz że istniejące endpointy nadal działają jak wcześniej.

Wygeneruj testy jednostkowe

Rozpocznij nowe okno kontekstowe za pomocą New task, a następnie zapytaj Boba:

Generate pytest unit tests for this application. Add pytest and httpx to a dev requirements file, build a test image, and run the suite in a container.

Bob dodaje zależności testowe pytest i httpx, buduje obraz, który je zawiera, uruchamia zestaw testów w kontenerze i raportuje wyniki. Uruchamianie testów w kontenerze oznacza, że nie potrzebujesz lokalnego środowiska Pythona. Przejrzyj i dopracuj wygenerowane testy.

Przeglądanie i utrzymywanie wygenerowanych testów pozostaje twoją odpowiedzialnością.

Wygeneruj dokumentację techniczną

Zapytaj Boba:

Generate technical documentation for this To-Do API.

Bob może wygenerować przegląd aplikacji, opis architektury, podsumowania endpointów, przykłady żądań i odpowiedzi oraz instrukcje użytkowania. Ta dokumentacja uzupełnia dokumentację API generowaną automatycznie przez FastAPI.