• 목록
• 답변
• 글쓰기
• 게시판 리스트 옵션
  • 수정
  • 삭제

Pro efektivní práci využijte také funkci Runner, která spouští celou kolekci najednou. Můžete nastavit počet iterací, zpoždění mezi požadavky a data z externího souboru (např. CSV). Runner vám dá přehledný report o tom, které testy prošly a které selhaly. Pokud testujete API pravidelně, zvažte použití příkazové řádky s Newmanem, který spustí kolekci bez otevření Postmanu. To se hodí pro integraci do CI/CD pipeline. Při psaní testů v Runneru myslete na to, že každá iterace by měla být nezávislá – pokud testujete vytváření záznamu, vždy na konci ověřte, že se záznam smazal, nebo použijte unikátní data.

Dalším krokem je verze API. V dokumentaci vždy uvádějte, pro kterou verzi popis platí. Pokud měníte chování endpointu, navrhněte změnu tak, aby starší klienti nebyli rozbití (např. pomocí rozšíření nebo nového endpointu). Typická chyba: backend změní formát data z „YYYY-MM-DD" nábytek na míru „DD.MM.YYYY" a frontend začne padat. Uveďte proto v dokumentaci i příklady formátů, a pokud je to možné, držte se konvencí, které frontend očekává.

Nezapomínejte ani na používání konvencí, pokud je tým má zavedené – typicky prefixy jako feat, fix, docs, refactor nebo test. Tyto prefixy nejsou samospasitelné, ale pomáhají rychle identifikovat povahu změny. Klíčové je, aby je všichni členové týmu chápali a dodržovali. Pokud taková konvence neexistuje, zaveďte ji společně – stačí pár pravidle, které budou všichni respektovat.

Testování odpovědí by mělo být automatizované. V záložce Tests můžete psát JavaScriptové skripty, které ověřují, že API vrací očekávaná data. Nejčastější testy kontrolují stavový kód – třeba expect(response.status).to.equal(200) – nebo přítomnost konkrétních polí v JSON odpovědi. Pomocí proměnných si můžete z odpovědi uložit potřebné hodnoty pro další požadavky, čímž vytvoříte sekvenci testů, která simuluje reálný uživatelský scénář. Pozor ale na to, aby testy nebyly příliš závislé na pořadí – pokud jeden selže, ostatní by neměly spadnout kvůli chybějícím datům.

Základní pravidlo zní: commit zpráva má odpovídat na otázku „co a proč", nikoli „jak". Popište, co jste změnili (např. „přidán filtr pro neaktivní uživatele") a proč („aby se nesnižoval výkon při načítání seznamu"). Vyhněte se technickým detailům implementace – ty jsou vidět v diffu. Pokud je to nutné, doplňte je až do těla zprávy, ale hlavní sdělení musí být čitelné i bez otevření kódu.

Na závěr si osvojte zvyk psát commit zprávu s ohledem na budoucí čtenáře: může to být váš kolega za půl roku, ale také vy sami za pět minut. Dobrá commit zpráva je investice, která se vrací při každém hledání v historii. Vyhněte se emocionálním komentářům a ironii – v profesionálním prostředí je místo pro fakta. Držte se pravidla: pokud byste zprávu mohli napsat i po dvou měsících bez otevření kódu, je pravděpodobně dostatečně smysluplná.

Prvním krokem je ujasnit si, co od licence očekáváte. Chcete, aby se vaše práce stala základem pro komerční produkty, nebo naopak chcete, aby každé odvozené dílo zůstalo otevřené? Pokud preferujete druhou možnost, zvažte tzv. copyleft licenci. Ta vyžaduje, aby i odvozeniny byly šířeny pod stejnou licencí. Naopak permisivní licence umožňují komukoli váš kód začlenit do proprietárního softwaru a ani nemusí zveřejnit své úpravy. Typickým příkladem copyleftu je GPL, mezi permisivní patří MIT či BSD.

Základním prvkem je popis každého endpointu. Uveďte metodu, If you have any type of inquiries concerning where and just how to use rady pro rekonstrukci, you could call us at our web-page. cestu, povinné a volitelné parametry. Rozlište, co jde v URL, co v query, co v hlavičce a co v těle. Ke každému parametru patří typ, povinnost a krátký příklad. Typickou chybou je popsat jen příklad odpovědi bez toho, aby bylo jasné, co znamená. Přidejte tedy schéma odpovědi – klidně jen jako příklad JSON, ale s komentářem, který vysvětlí klíčové položky. Takový popis ušetří desítky zbytečných otázek.

Častým problémem bývá špatné nastavení hlaviček, zejména Content-Type a Accept. Při odesílání JSON těla musíte nastavit Content-Type: application/json, jinak server nemusí požadavek správně zpracovat. Podobně u autorizace – mnoho API vyžaduje hlavičku Authorization s tokenem, který se může měnit. Uložte si token do proměnné a používejte jej v hlavičce jako token. Vyhnete se tak ručnímu kopírování hodnot a chybám při překlepu. Další častou chybou je ignorování odpovědí s chybovým stavem – vždy si prohlédněte tělo odpovědi i při 400 a 500, protože obsahuje důležité informace pro ladění.

Na závěr: dokumentace není jen seznam endpointů. Je to smlouva mezi týmy. Když ji napíšete dobře, frontend může pracovat samostatně a backend nemusí odpovídat na stejné dotazy desetkrát. Investujte čas do úvodního přehledu, autentizace a popisu chyb – to jsou tři nejčastější oblasti, kde vznikají problémy. A pokud dokumentace chybí, řešte to jako chybu v kódu, ne jako kosmetiku.