Rest API » Historie » Verze 15
Vojtěch Váchal, 2022-03-23 13:52
1 | 1 | Vojtěch Váchal | h1. Rest API |
---|---|---|---|
2 | |||
3 | * offline mobilní aplikace |
||
4 | * při připojení k internetu bude posílat dosažené výsledky a stahovat nové úlohy a balíky přidělené terapeutem |
||
5 | * potřeba navrhnout a implementovat Rest API, se kterým bude moct aplikace komunikovat |
||
6 | |||
7 | ---- |
||
8 | |||
9 | 13 | Vojtěch Váchal | h3. Schůzka s M. Horkým dne 22. března 2022 |
10 | |||
11 | * záznam ze schůzky, kde se řešil návrh JSON objektu, který bude odesílán z webové aplikace a diskuze nad ověřováním uživatele |
||
12 | |||
13 | h4. Návrh JSONu |
||
14 | |||
15 | 14 | Vojtěch Váchal | Co se týká JSON objektu, byla schválena následují podoba viz. příloha -> attachment:json_desing_out.txt |
16 | 13 | Vojtěch Váchal | |
17 | 15 | Vojtěch Váchal | Pro vytvoření metod lze použít následující konfiguraci pro PostMan - attachment:BrainIn_-_Rest_API.postman_collection.json |
18 | 13 | Vojtěch Váchal | |
19 | h4. Ověřování uživatele |
||
20 | |||
21 | * v aktuální implementaci se využívá nějaká .NET knihovna, která hashování řeší sama |
||
22 | * nakonec bylo domluveno, že mobilní aplikace bude posílat *jméno a heslo v _plaintext_ formě* |
||
23 | ** přes SSL |
||
24 | * v budoucnu lze přistoupit k asymetrickému šifrování či změnit implementaci ověřování (_"udělat si vlastní"_) |
||
25 | |||
26 | ---- |
||
27 | |||
28 | 9 | Vojtěch Váchal | h3. Schůzka s M. Horkým dne 14. března 2022 |
29 | 7 | Vojtěch Váchal | |
30 | * záznam ze schůzky, kde se probíral návrh API a dořešení dalších otázek, které vznikly při analýze |
||
31 | |||
32 | h4. Odesílání souborů |
||
33 | |||
34 | * odesílat se budou komprimované soubory pomocí kompresního programu *Gzip* |
||
35 | * následně se bude soubor převádět do řetězce v *Base64* formátu, který bude přiložen do odesílaného JSONu |
||
36 | * dle zákazníka se zatím jedná pouze o prvotní verzi a není prý úplně důvod tolik řešit optimalizaci |
||
37 | ** _"z počátku (v prvních iteracích) upřednostnit jednodušší a rychlejší řešení, než optimalizaci - tu pak můžeme dotáhnout, když to půjde hladce a zbyde čas"_ |
||
38 | |||
39 | h4. Autorizace |
||
40 | |||
41 | * co se týká autorizace, řešení je zcela na nás |
||
42 | * nejspíše nebude potřeba speciální endpoint pro ověřování |
||
43 | * potřeba zaheshovat login a heslo |
||
44 | ** _"ověření pacienta (hashovaný login/heslo) - potřebuji pak informaci o typu hashovací funkce"_ |
||
45 | |||
46 | h4. Endpointy a data |
||
47 | |||
48 | * celkový počet endpointů zatím vypadá na 2 |
||
49 | 8 | Vojtěch Váchal | ** asi nebudeme vytvářet Swagger API, nemá moc smysl pro 2 endpointy |
50 | 7 | Vojtěch Váchal | * formát komunikace *JSON* |
51 | * návrh API proběhne v iterace od 15.3. - 29.3.2022 |
||
52 | |||
53 | h4. Základní scénář |
||
54 | |||
55 | # Připojení pacienta k internetu. |
||
56 | # Po zapnutí aplikace request s datumem posledního stažení změn. |
||
57 | # Zpět informace o nových změnách (nově přidělené balíky, změny v přidělených úlohách). |
||
58 | ** U každé úlohy potřebuji ID šablony. |
||
59 | ** Ke každé úloze by také měla být kompletní konfigurace včetně všech multimediálních souborů. |
||
60 | ** Datum změny by mohlo být umístěno někde v databázi - prověřit. |
||
61 | # Kdykoli se pak může odeslat JSON s nasbíranými daty. |
||
62 | ** Tady pozor na možné změny v balících - pokud nedošlo k celkovému odstranění úlohy - myslím opravdu celkovému ne pouze z balíku - tak by se data měla uložit vždy). |
||
63 | |||
64 | ---- |
||
65 | |||
66 | 1 | Vojtěch Váchal | h3. Odesílání souborů přes Rest API |
67 | |||
68 | * po analýze bylo zjištěno a nalezena 2 řešení, která by byla možná implementovat |
||
69 | * potřeba probrat s M. Horkým na nějaké schůzce, které řešení se zvolí, zda by bylo potřeba řešit úplně jinak |
||
70 | |||
71 | 7 | Vojtěch Váchal | h4. -1. Řetězec v Base64- |
72 | 1 | Vojtěch Váchal | |
73 | 7 | Vojtěch Váchal | * -Base64 je kódování, které převádí binární data na posloupnosti tisknutelných znaků.- |
74 | * -umožňuje přenos binárních dat kanály, které dovolují pouze přenos textů.- |
||
75 | * -Výhody:- |
||
76 | ** -funguje na jakákoliv binární data (obrázky, soubory, ...)- |
||
77 | ** -velice jednoduchá implementace v C#- |
||
78 | * -Nevýhody- |
||
79 | ** -největší nevýhodou tohoto řešení je, že velikost vytvořeného/odesílaného řetězce je zhruba o 20-30% větší-- |
||
80 | 1 | Vojtěch Váchal | |
81 | h4. 2. Komprimované Base64 |
||
82 | |||
83 | 7 | Vojtěch Váchal | * *nevýhodu prvního řešení lze odstranit nějakou kompresí (Gzip, DeflateStream, ...)* |
84 | * *podle zvolené komprese by se sice ztrácela kvalita obrázků, ale přenos dat by se mohl zrychlit, protože velikost dat by měla být menší* |
||
85 | ** *nechceme aby stahování/odesílání trvalo příliš dlouho (pacient může trénovat pouze po dobu jedné hry, či pouze zkoumat dosažené výsledky)* |
||
86 | * *řešení by fungovalo tak, že by se* |
||
87 | ** *zapnula aplikace a zahájilo se tak stahování/odesílání potřebného obsahu* |
||
88 | ** *mobilní aplikace by přijala komprimovaný obrázek v base 64 formátu* |
||
89 | 1 | Vojtěch Váchal | |
90 | 7 | Vojtěch Váchal | * *pokud by byla potřeba stejná kvalita obrázků, jak v aplikace tak v systému byla by možnost spolu s komprimovaným obrázkem posílat i url* |
91 | ** *url by obsahovala adresu, kde by se nacházel soubor v plné kvalitě* |
||
92 | ** *po stažení všech potřebných/nových dat ze systému by se na pozadí aplikace zahájilo stahování obrázků v plné kvalitě a nenarušovalo uživatele* |
||
93 | 2 | Vojtěch Váchal | |
94 | 7 | Vojtěch Váchal | h4. -3. Použít multipart/from-data namísto JSONu- |
95 | 4 | Daniel Wébr | |
96 | 7 | Vojtěch Váchal | * -POST a PUT metody jsou RESTFull, jak jen to jde- |
97 | ** -obsahují textový vstup společně se soubory- |
||
98 | * -nevýhodou je, že přenos už nebude realizovaný pomocí JSONu, který je daleko jednodušší k testování, ladění, ...- |
||
99 | 4 | Daniel Wébr | |
100 | h3. Autorizace přeš API |
||
101 | |||
102 | 7 | Vojtěch Váchal | * -vhodné přes autorizační token získaný při přihlášení s omezenou platností- |
103 | ** -potřeba ujasnit u zákazníka (na předchozí schůzce zmiňoval, že ještě upřesní své požadavky)- |
||
104 | 1 | Vojtěch Váchal | |
105 | 7 | Vojtěch Váchal | * tento bod byl dne 14.3. vyjasněn se společníkem zákazníka (M. Horký) |
106 | 10 | Vojtěch Váchal | ** konkrétní informace lze dohledat v tomto dokumentu výše (viz. [[#Schůzka s M. Horkým dne 14. března 2022]]) |
107 | 7 | Vojtěch Váchal | |
108 | 12 | Daniel Wébr | * provedena analýza provedené hashovací funkce (viz https://stackoverflow.com/questions/20621950/asp-net-identitys-default-password-hasher-how-does-it-work-and-is-it-secure) |
109 | 11 | Daniel Wébr | ** nutná konzultace se zákazníkem o vyhovujcí variantě authorizace |
110 | ** původní varianta ukládání zaheshovaného hesla by byla složita z důvodu solení hashe |
||
111 | |||
112 | 1 | Vojtěch Váchal | h3. Navrhované endpointy |
113 | |||
114 | * podoba endpointů bude vytvořena po zhodnocení nároků a vlastností mobilní aplikace pro kterou API vzniká |
||
115 | 7 | Vojtěch Váchal | |
116 | 8 | Vojtěch Váchal | * tento bod byl dne 14.3. konzultován se společníkem zákazníka (M. Horký) |
117 | 9 | Vojtěch Váchal | ** konkrétní informace lze dohledat v tomto dokumentu výše (viz. [[#Schůzka s M. Horkým dne 14. března 2022]]) |