6.0 KiB
Priimkite API
Apžvalga
API atveria begalines galimybes kūrybiniam žiniatinklio kūrimui! Šiame užduotyje jūs pasirenkate išorinį API ir kuriate naršyklės plėtinį, kuris išsprendžia tikrą problemą arba teikia vertingą funkcionalumą vartotojams.
Nurodymai
1 žingsnis: Pasirinkite savo API
Pasirinkite API iš šio kruopščiai atrinkto nemokamų viešųjų API sąrašo. Apsvarstykite šias kategorijas:
Populiarūs pasirinkimai pradedantiesiems:
- Pramogos: Dog CEO API atsitiktinėms šunų nuotraukoms
- Orai: OpenWeatherMap dabartinei orų informacijai
- Citatos: Quotable API įkvepiančioms citatoms
- Naujienos: NewsAPI dabartinėms antraštėms
- Linksmi faktai: Numbers API įdomiems skaičių faktams
2 žingsnis: Suplanuokite savo plėtinį
Prieš rašydami kodą, atsakykite į šiuos planavimo klausimus:
- Kokią problemą sprendžia jūsų plėtinys?
- Kas yra jūsų tikslinis vartotojas?
- Kokius duomenis saugosite vietinėje atmintyje?
- Kaip tvarkysite API klaidas ar spartos apribojimus?
3 žingsnis: Sukurkite savo plėtinį
Jūsų plėtinys turėtų apimti:
Būtinos funkcijos:
- Formos laukeliai bet kokiems reikiamiems API parametrams
- API integracija su tinkamu klaidų valdymu
- Vietinė atmintis vartotojo nustatymams arba API raktams
- Švari, reaguojanti vartotojo sąsaja
- Įkėlimo būsena ir vartotojo grįžtamasis ryšys
Kodo reikalavimai:
- Naudokite modernias JavaScript (ES6+) savybes
- Įgyvendinkite async/await API užklausoms
- Įtraukite tinkamą klaidų valdymą su try/catch blokais
- Pridėkite prasmingų komentarų, paaiškinančių jūsų kodą
- Laikykitės nuoseklumo formatuojant kodą
4 žingsnis: Testuokite ir patobulinkite
- Testuokite plėtinį su įvairiais įvesties duomenimis
- Tvarkykite kraštutinius atvejus (nėra interneto, netinkami API atsakymai)
- Užtikrinkite, kad plėtinys veikia po naršyklės paleidimo iš naujo
- Pridėkite draugiškas vartotojui klaidų žinutes
Papildomi iššūkiai
Pakelkite savo plėtinį į kitą lygį:
- Pridėkite kelis API galinius taškus platesniam funkcionalumui
- Įgyvendinkite duomenų talpinimą, kad sumažintumėte API užklausas
- Sukurkite klaviatūros spartiuosius mygtukus dažnoms užduotims
- Pridėkite duomenų eksportavimo/importavimo funkcijas
- Įgyvendinkite vartotojo pritaikymo parinktis
Pateikimo reikalavimai
- Veikiantis naršyklės plėtinys, sėkmingai integruotas su jūsų pasirinktiniu API
- README failas, aiškinantis:
- Kurį API pasirinkote ir kodėl
- Kaip įdiegti ir naudoti jūsų plėtinį
- Bet kokie API raktai ar nustatymai, kurių reikia
- Ekrano nuotraukos, rodantys jūsų plėtinį veikiant
- Švarus, komentuotas kodas, atitinkantis modernias JavaScript praktikas
Vertinimo kriterijai
| Kriterijus | Puikiai (90-100%) | Gerai (80-89%) | Vystymasis (70-79%) | Pradžia (60-69%) |
|---|---|---|---|---|
| API integracija | Be priekaištų API integracija su išsamiu klaidų valdymu ir kraštutinių atvejų tvarkymu | Sėkminga API integracija su pagrindiniu klaidų valdymu | API veikia, bet klaidų valdymas ribotas | API integracijoje yra rimtų problemų |
| Kodo kokybė | Švarus, gerai komentuotas modernus JavaScript, laikantis geriausių praktikų | Gera kodo struktūra su pakankamais komentarais | Kode veikia, bet reiktų geresnės organizacijos | Prasta kodo kokybė, minimalūs komentarai |
| Vartotojo patirtis | Išbaigta sąsaja su puikiomis įkėlimo būsenomis ir vartotojo grįžtamuoju ryšiu | Gera sąsaja su pagrindiniu vartotojo grįžtamuoju ryšiu | Pagrindinė sąsaja, kuri veikia pakankamai gerai | Prasta vartotojo patirtis, paini sąsaja |
| Vietinė atmintis | Sudėtingas vietinės atminties naudojimas su duomenų patikra ir valdymu | Tinkamas vietinės atminties panaudojimas pagrindinėms funkcijoms | Pagrindinis vietinės atminties panaudojimas | Minimalus ar neteisingas vietinės atminties naudojimas |
| Dokumentacija | Išsami README su diegimo instrukcijomis ir ekrano nuotraukomis | Gera dokumentacija, apimanti daugumą reikalavimų | Pagrindinė dokumentacija, trūksta kai kurių detalių | Prasta arba trūkstanti dokumentacija |
Pradžios patarimai
- Pradėkite paprastai: Pasirinkite API, nereikalaujantį sudėtingos autentifikacijos
- Perskaitykite dokumentaciją: Kruopščiai supraskite savo pasirinkto API galinius taškus ir atsakymus
- Suplanuokite vartotojo sąsają: Nubraižykite savo plėtinio sąsają prieš rašydami kodą
- Dažnai testuokite: Kurkite palaipsniui ir testuokite kiekvieną pridėtą funkciją
- Tvarkykite klaidas: Visada manykite, kad API užklausos gali nepavykti, ir tam ruoškite planą
Ištekliai
- Naršyklės plėtinių dokumentacija
- Fetch API vadovas
- Vietinės atminties pamoka
- JSON analizė ir valdymas
Linkime smagaus ir kūrybingo darbo! 🚀
Atsakomybės apribojimas:
Šis dokumentas buvo išverstas naudojant dirbtinio intelekto vertimo paslaugą Co-op Translator. Nors siekiame tikslumo, atkreipkite dėmesį, kad automatizuoti vertimai gali turėti klaidų ar netikslumų. Originalus dokumentas gimtąja kalba turėtų būti laikomas autoritetingu šaltiniu. Kritinei informacijai rekomenduojamas profesionalus žmogaus vertimas. Mes neatsakome už bet kokius nesusipratimus ar klaidingas interpretacijas, kylančias dėl šio vertimo naudojimo.