Přeskočit na obsah

Jak používat dokumentaci

docsVerze 0.1.0CS

1. Vyberte produkt a verzi

Sekce “1. Vyberte produkt a verzi”

Verze v záhlaví stránky patří dokumentovanému produktu. Verze API může být odlišná. Porovnejte ji s verzí služby, kterou používáte. Návod pro jinou verzi nemusí odpovídat vašemu nasazení.

2. Najděte správný typ návodu

Sekce “2. Najděte správný typ návodu”

Quickstart pomůže s prvními kroky. Guide řeší konkrétní úkol, tutorial vede celým postupem a concepts vysvětlují souvislosti. API reference popisuje operace, parametry a odpovědi. Při změně verze použijte changelog a migration guide.

Otevřete vyhledávání, zadejte například „autentizace“ a případně vyberte produkt, produktovou/API verzi, jazyk nebo typ. Hledání pracuje s veřejným indexem, který se stáhne do vašeho prohlížeče.

4. Ověřte ukázku před použitím

Sekce “4. Ověřte ukázku před použitím”

Ukázkové identifikátory a tokeny jsou syntetické. Host api.example.invalid není produkční služba. Vlastní credentials ukládejte podle návodu konkrétní služby; nevkládejte je do veřejného JavaScriptu. API reference slouží ke čtení. Dokumentace sama neuděluje oprávnění k API a automaticky na něm nespouští operace.

5. Použijte přenositelný zdroj

Sekce “5. Použijte přenositelný zdroj”

U schváleného obsahu můžete stáhnout Markdown a OpenAPI JSON/YAML. llms.txt obsahuje veřejné vstupní odkazy pro strojové čtení. Stažený soubor patří uvedené verzi; při aktualizaci znovu zkontrolujte changelog.

© MiloslavHub · CC BY 4.0