IBM Bob ile yapay zeka eşli programlama

IBM Bob'u başlat

IBM Bob IDE'yi başlat.

Bob sohbet arayüzünü aç

Bob sohbet arayüzü görünmüyorsa, gezinti çubuğunun yanındaki Bob simgesini seçerek açabilirsin. Mac'te Option + Command + B, Windows ve Linux'ta ise Ctrl + Alt + B tuşlarına da basabilirsin.

Boş bir proje klasörü aç

todo-api adında boş bir klasör oluştur, ardından File > Open Folder ile Bob'da aç. Bob, klasördeki dosyaların yazarlarına güvenip güvenmediğini sorarsa Yes, I trust the authors seçeneğini seç.

Bob, üretilen uygulamayı bu klasöre yazar. Bu öğretici için mevcut bir repository'ye gerek yoktur.

Otomatik onayı devre dışı bırak

Permissions bölümünü aç ve otomatik onayın kapalı olduğunu doğrula. Otomatik onay kapalıyken Bob, dosyaları okumadan, düzenlemeden veya komut çalıştırmadan önce iznini ister. Bu öğreticide her değişikliği senin kontrolünde tutarsın.

Plan moduna geç

Bob kenar çubuğunun altındaki mod açılır menüsünü açıp Plan seçeneğini seç.

Modlar en az ayrıcalık ilkesini uygular. Plan modunda Bob, kodunu okur ve bir Markdown planı yazar. Bob komut çalıştırmaz veya uygulama değişikliği yapmaz. Bob herhangi bir uygulama kodu yazmadan önce yaklaşımı gözden geçirirsin.

Uygulama gereksinimlerini tanımla

Bob sohbet arayüzüne aşağıdaki istemi gir:

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.

Planı oluşturmak için Bob planlama skill'ini çalıştırır. İstendiğinde Approve skill tools for task ve Approve subagent tools for task seçeneklerini seç; böylece Bob çalışma alanını araştırıp planı taslak haline getirebilir.

Planı iyileştir

Bob herhangi bir kod yazmadan önce planı değiştirebilirsin. Bob sohbet arayüzüne takip istemi gir:

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

Bob, ekstra giriş doğrulamasını içerecek şekilde planı revize eder. Güncellenmiş planı incele.

Planı incele

Bob sıralı bir plan sunar ve bunu projede Markdown dosyası olarak kaydedebilir. Devam etmeden önce incele:

• Kapsam: Plan, eklediğin doğrulama kuralı dahil tüm endpoint'leri kapsamalı ve istemediğin hiçbir şeyi içermemelidir.
• Adlandırılmış dosyalar: Her adım, oluşturduğu veya değiştirdiği dosyayı adıyla belirtmelidir.
• Belirsiz ifadeler: "Hataları uygun şekilde yönet" gibi ifadeler varsayımları gizler. Bob'dan bunları somut hale getirmesini iste.

Bu tasarım kararlarından sen sorumlusun. Bob, Uygulamayı üret ve incele bölümünde Agent moduna geçene kadar hiçbir şey uygulamaz.

Yeni bir bağlam penceresi başlat

Yeni bir bağlam penceresi başlatmak için sohbet kutusundaki New task veya sohbet panelinin üstündeki + seçeneğini seç. Arka plan için Yeni bir bağlam penceresi oluşturma sayfasına bakabilirsin. Bob planı plans klasörüne kaydettiğinden artık planlama konuşmasına bağlamda ihtiyacın yok. Temiz bir bağlam, uygulamanın onaylanan plana odaklanmasını sağlar.

Agent moduna geç ve planı çalıştır

Bob kenar çubuğunun altındaki mod açılır menüsünü açıp Agent seçeneğini seç. Ardından Bob'a planı uygulamasını söyle:

Implement the plan in the plans folder.
@plans/

Agent modu, Bob'un dosya yazmasına ve komut çalıştırmasına izin verir. Otomatik onayı devre dışı bıraktığın için Bob, her değişiklikten önce onay ister. Bob plan üzerinde çalışırken adımları onayla.

Üretilen uygulamayı incele

Uygulama tamamlandığında üretilen kodu incele. Bob'un çıktısı olasılıksal olduğundan, kod stili ve iç adlar buradaki örneklerden farklı olabilir. Uygulama aşağıdaki parçalardan oluşur.

Veri modelleri. Bob iki Pydantic modeli üretir: biri görev oluştururken istek gövdesi için, diğeri depolanan bir görev için. Oluşturma modeli, planlama sırasında eklediğin uzunluk kuralını uygular:

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


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

Endpoint yolları ve durum kodları Bob'a verdiğin gereksinimlere uyar; ancak model sınıf adları ve dosya düzeni değişkenlik gösterebilir. Bu öğretici Task ve TaskCreate modellerini varsayar. Bob farklı adlar seçtiyse takip eden istemleri buna göre düzenle.

Bellek içi veri deposu. Bob, görevleri boş bir Python listesinde depolar ve her yeni göreve artan bir id atar:

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

API işlemleri. Uygulama aşağıdaki endpoint'leri sağlar:

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

POST /tasks yalnızca istek gövdesinde task_name alır ve oluşturulan görevle birlikte 201 döner. DELETE /tasks/{task_id} başarıda 204, o task_id'ye sahip görev yoksa 404 döner.

Bağımlılıklar. Bob, FastAPI, Uvicorn ve Pydantic'i listeleyen bir requirements.txt dosyası üretir.

Container. Bob, bağımlılıkları kuran ve API'yi Uvicorn ile 8000 portunda çalıştıran bir Dockerfile üretir.

HTTP kontratı, yöntemler, yollar ve durum kodları dahil olmak üzere gereksinimlerin istemine uyar. Aşağıdaki doğrulama adımları olduğu gibi uygulanır.

Uygulama dosyasını aç

Bob'un ürettiği main.py dosyasını aç ve imlecini dosyanın sonundaki boş bir satıra, son route handler'ının ardına yerleştir.

Literate coding modunu etkinleştir

Mac'te Command + I, Windows ve Linux'ta ise Ctrl + I tuşlarına bas. Editör araç çubuğundaki sihirli değnek simgesini de seçebilirsin.

Talimatı yaz

Boş satıra aşağıdaki talimatı gir. Kodun geri kalanından farklı bir renkte vurgulanmış olarak görünür.

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, parametre adını, istek modelini ve hata yönetimini çevreleyen koddan çıkarır; bu nedenle yalnızca yöntemi ve yolu belirtmen yeterlidir.

Kodu üret ve kabul et

Generate seçeneğini seç ya da Mac'te Command + Enter, Windows ve Linux'ta ise Ctrl + Enter tuşlarına bas. Bob, talimatını bir uygulamayla değiştirir ve satır içi bir diff gösterir.

Diff'i incele, ardından değişikliği uygulamak için Accept All seçeneğini seç. Literate coding modundan çıkmak için Mac'te Command + I, Windows ve Linux'ta ise Ctrl + I tuşlarına tekrar bas.

Bob'dan kodu açıklamasını iste

New task ile yeni bir bağlam penceresi başlat, ardından mod açılır menüsünden Ask seçeneğini seç. Ask modu, dosyaları düzenlemeden soruları yanıtlar ve kodu analiz eder. Değişiklik yapmadan açıklama istediğinde kullan.

Üretilen kodu anlamak, yapay zeka eşli programlamanın önemli bir parçasıdır. Bob'a sor:

Explain the generated To-Do API.

Bob, uygulama mimarisini, veri akışını, FastAPI bileşenlerini, Pydantic modellerini, endpoint davranışını ve tasarım kararlarını açıklayabilir. Kodu değiştirmeden veya genişletmeden önce beklediğin gibi çalıştığını doğrulamak için açıklamayı kullan.

Uygulamayı çalıştır

Bob'un komut çalıştırabilmesi için Agent moduna geri dön. Bob'dan API'yi bir container içinde derleyip çalıştırmasını iste:

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

Bob, derleme ve başlatma komutlarını çalıştırır ve container çalışmaya başladığında bildirir.

Tarayıcında http://localhost:8000/docs adresini aç.

FastAPI, /docs adresinde etkileşimli bir Swagger UI sunar. Her endpoint'i keşfetmek, istek ve yanıt şemalarını incelemek ve tarayıcıdan API çağrıları yapmak için bunu kullanabilirsin.

API'yi doğrula

Her işlemi test etmek için /docs adresindeki Swagger UI'yi kullan. Her endpoint için:

1. Satırını genişlet ve Try it out seçeneğini seç.
2. Path parametrelerini veya istek gövdesini gir.
3. Execute seçeneğini seç.
4. Server response kodunu ve gövdesini kontrol et.

Görev ekle

1. POST /tasks'ı genişlet ve Try it out seçeneğini seç.

2. İstek gövdesini şununla değiştir:

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

3. Execute seçeneğini seç. Yanıt kodunun 201 olduğunu ve yanıt gövdesinin atanmış bir id ile oluşturulan görevi gösterdiğini doğrula.

Görevleri al

1. GET /tasks'ı genişlet ve Try it out seçeneğini seç.
2. Execute seçeneğini seç. Yanıt kodunun 200 olduğunu ve yanıt gövdesinin, eklendiğinde atanan id ile birlikte My first API item! görevini listelediğini doğrula.

Görevi güncelle

1. PUT /tasks/{task_id}'yi genişlet ve Try it out seçeneğini seç.

2. Oluşturduğun görevin task_id'sini gir.

3. İstek gövdesini şununla değiştir:

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

4. Execute seçeneğini seç. Yanıt kodunun 200 olduğunu ve dönen görevin güncellenmiş task_name'i gösterdiğini doğrula.

5. task_id'yi var olmayan bir değere değiştir ve Execute'u tekrar seç. Yanıt kodunun 404 olduğunu doğrula.

Görevi sil

1. DELETE /tasks/{task_id}'yi genişlet ve Try it out seçeneğini seç.
2. Oluşturduğun görevin task_id'sini gir ve Execute seçeneğini seç. Yanıt kodunun 204 olduğunu doğrula.
3. GET /tasks'ı genişlet, Execute seçeneğini seç ve görevin artık yanıtta görünmediğini doğrula.
4. DELETE /tasks/{task_id}'yi tekrar genişlet, aynı task_id'yi gir ve Execute seçeneğini seç. Yanıt kodunun 404 olduğunu doğrula.

Uygulama, literate coding ile eklediğin güncelleme endpoint'i dahil olmak üzere orijinal gereksinimleri karşılar.

Bob'dan iyileştirme önerileri iste

New task ile yeni bir bağlam penceresi başlat, ardından şunu gir:

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

Bob, tek bir görevi almak için eksik bir endpoint, doğrulanmış Task modelleri yerine düz sözlükler tutan bir bellek içi depo ve sıfırlanması veya test edilmesi zor olan modül düzeyinde bir id_counter gibi eksiklikleri tanımlar.

İyileştirmeleri uygula

Bob'dan saklamak istediğin önerileri uygulamasını iste:

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.

Önerilen değişiklikleri incele ve uygulamak için onayla. Bob'dan imajı yeniden oluşturmasını ve container'ı yeniden başlatmasını iste, ardından doğrulama adımlarını tekrarla. Geçerli bir ID için GET /tasks/{task_id}'nin 200 ve görev ile, bilinmeyen bir ID için 404 döndürdüğünü, ve mevcut endpoint'lerin önceki gibi davrandığını doğrula.

Birim testleri üret

New task ile yeni bir bağlam penceresi başlat, ardından Bob'a sor:

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, pytest ve httpx test bağımlılıklarını ekler, bunları içeren bir imaj oluşturur, paketi bir container içinde çalıştırır ve sonuçları raporlar. Testleri bir container içinde çalıştırmak, yerel bir Python ortamına ihtiyacın olmadığı anlamına gelir. Üretilen testleri incele ve geliştir.

Üretilen testlerin incelenmesi ve bakımı senin sorumluluğundadır.

Teknik belgeler üret

Bob'a sor:

Generate technical documentation for this To-Do API.

Bob, uygulama genel bakışı, mimari açıklama, endpoint özetleri, istek ve yanıt örnekleri ve kullanım talimatları üretebilir. Bu belgeler, FastAPI'nin otomatik olarak ürettiği API belgelerini tamamlar.