Dersler ve öğrenme oyunu

Bir cihaz API'si tasarla

ESP32-C3 üzerindeki bir lamba için bir HTTP API'si tasarlar, ders ders, ilk rotadan üretilen belgelere ve sözleşme testine kadar.

Bir cihaz API'si tasarla, Kodlama izinde İleri seviye bir kurstur. Her ders WiFi lambası devresini (GPIO 8'de bir LED) yeni bir C++ kodla açar ve lambaya bir uygulamanın yapacağı gibi konuşursunuz: istekler, durum kodları ve JSON. Yaklaşık altı saat sürer.

Ders ders ne inşa ediyorsun

  • Resources and routes: a routing table, paths that name things, and why GET /turnOn is a bug that switches the lamp on at 3 in the morning. You add a /device resource of your own.
  • Metotlar: PUT değiştirir, PATCH bir parçayı değiştirir, POST oluşturur (201 ve bir Location), DELETE kaldırır (204). Güvenli ve etkisiz (idempotent) metotlar ve bir yolun kabul etmediği bir metot için Allow başlıklı 405.
  • JSON şemaları: JSON Schema olarak lambanın sözleşmesi, her alanı kontrol eden ve tüm sorunları tek seferde 422 ile yanıtlayan bir PUT ve yanlış yazılmış bir alanı yok saymak yerine reddetme.
  • Hatalar: 400, 409, 422 ve 503, ne zaman tekrar deneneceğini söyleyen bir Retry-After, her hata için tek bir hata biçimi ve bir istemcinin izlemesi gereken yeniden deneme kuralları.
  • Kimlik anahtarları: bearer anahtarları, 401 ile 403 farkı, sabit süreli karşılaştırma, kayıtlara yazılmayan anahtarlar ve gerçek bir cihazın sırlarını nerede tuttuğunun dürüst bir anlatımı (kodda değil ve yalnızca TLS üzerinden).
  • Sürümleme: kırıcı bir yeniden adlandırma /v2 alır, /v1 bir Sunset tarihiyle çalışmaya devam eder, ikisi de tek bir lambanın görünümleridir ve eklenen bir alan hiç yeni sürüm gerektirmez.

Boss: belgelenmiş bir lamba API'si

Son ders tüm API'nin 1. sürümünü teslim eder: yollar, metotlar, doğrulanmış bir şema, tek bir hata biçimi ve anahtarlar. Yönlendirme tablosu tek doğruluk kaynağıdır, bu yüzden GET /v1/docs ondan üretilir ve koddan kopamaz. Bir sözleşme testi takımı (türü test) on dört durumu bir istemcinin yapacağı gibi çağırır, çoğu hatadır, ve contract: 14 of 14 passed yazdırır. Bir sağlık kontrolü yolunu üç satırda belgeleri ve testiyle birlikte ekler, sonra bir uygulama geliştiricinin ihtiyaç duyacağı API kılavuzunu yazarsın.

İstekler lambaya nasıl ulaşır

The editor's network is simulated (see WiFi, simüle): bir kartın web sunucusuna ulaşabilen tek istemci Web panelidir ve üstbilgisiz GET gönderir. Bir API dersi için PUT, PATCH, DELETE, JSON gövdeleri ve bir Authorization üstbilgisi gerekir, bu yüzden her kodda ikinci bir giriş yolu vardır: seri monitör küçük bir curl'dür. Şunu yaz: PUT /lamp {"on":true,"brightness":40} and it prints the status, one header and the body. Both ways in reach the same route() function, which is good design anyway: a handler should not care how a request arrived.

Simüle edilmiş ağda TLS yoktur, bu yüzden her bayt okunabilir durumdadır. Kodlardaki anahtarlar tanıtım amaçlı anahtarlardır, tasarım gereği herkese açıktır ve yetkilendirme dersi bir ürünün bunun yerine ne yapması gerektiğini anlatır.

Başlamadan önce

ESP32-C3 üzerinde C++ ile ve üzerinde WiFi ile bir web sunucusuyla rahat olmalısın. Bağlı cihazlar ağ tarafını kapsar. Sonrasında Üç kartla dağıtık sistemler yeniden deneme ve etkisizlik fikirlerini alır ve üç kart boyunca çalıştırır.