Projekt

Obecné

Profil

Architektura systému » Historie » Verze 36

Zdeněk Častorál, 2020-03-30 14:32

1 1 Ondřej Váně
h1. Architektura systému
2 2 Ondřej Váně
3 5 Ondřej Váně
* Systému bude rozdělen do třech základních částí, které mezi sebou budou komunikovat pomocí REST API (JSON).
4 6 Ondřej Váně
** Frontend - Angular, TypeScript
5
** Backend - Spring, Java
6
** Souborová databáze - Apache Solr
7 7 Ondřej Váně
* Každá jednotlivá část bude spuštěna v dockeru kontejneru. 
8 8 Ondřej Váně
* Architektura systému je znázorněna na obrázku níže.
9 3 Ondřej Váně
10 4 Ondřej Váně
!architecture.png!
11 9 Ondřej Váně
12 36 Zdeněk Častorál
[[Komunikační protokol]]
13
14 10 Ondřej Váně
h1. Komunikační protokol v.1
15 11 Ondřej Váně
16
* Jednotlivé zprávy budou zasílány ve fromátu JSON
17
* Komunikace bude probíhat pomocí HTTP protokolu
18
* Budou využívány návratové HTTP kódy stavů (200, 400, 500, atd.) - později bude upřesněno
19 32 Ondřej Váně
* Návrh komunikace na obrázku níže.
20
21
h2. REST API - URL
22
23 35 Ondřej Váně
* */search*: POST => hledání výrazu v dokuemntech
24
* */documents*: POST => přídání nového dokumentu a obrázku
25
* */documents*: GET   => vypsání všech dokumetů (název, datum, atd.) jen základní info
26 11 Ondřej Váně
27
!kom_protokol.png!
28 12 Ondřej Váně
29
* Struktura jednotlivých zpráv
30
** Query message:
31 14 Ondřej Váně
<pre><code class="json">
32
{ 
33 15 Ondřej Váně
	"query": "hledaný výraz", 
34
	"date": "čas odeslání dotazu" 
35
	
36
}
37
</code></pre>
38
** Query to Solr message:
39
<pre><code class="json">
40
{ 
41 17 Ondřej Váně
	"query": "Pole pro vyhledávání : hledaný výraz"
42 15 Ondřej Váně
	
43
}
44
</code></pre>
45
** Query result from Solr:
46
<pre><code class="json">
47 19 Ondřej Váně
{
48 22 Ondřej Váně
   "IdDocument":"id dokumentu",
49
   "TextRegion":{
50
      "PlainText":"text region",
51
      "Coords":"koordináty regionu",
52
      "TextLine":[
53
         {
54
            "PlainText":"text line",
55
            "Coords":"koordináty řádky",
56
            "TextWord":[
57
               {
58
                  "PlainText":"text word",
59
                  "Coords":"koordináty slova"
60
               }
61
            ]
62
         }
63
      ]
64
   }
65
}
66 15 Ondřej Váně
</code></pre>
67
68
** Query response:
69
<pre><code class="json">
70 23 Ondřej Váně
{
71
   "IdDocument":"id dokumentu",
72
   "DocumentImage":"Obrázek v Base64",
73
   "TextRegion":{
74
      "PlainText":"text region",
75
      "Coords":"koordináty regionu",
76
      "TextLine":[
77
         {
78
            "PlainText":"text line 1",
79
            "Coords":"koordináty řádky",
80
            "TextWord":[
81
               {
82
                  "PlainText":"text word 1",
83
                  "Coords":"koordináty slova"
84
               }
85
            ]
86
         }
87
      ]
88
   }
89 14 Ondřej Váně
}
90 13 Ondřej Váně
</code></pre>
91 24 Ondřej Váně
92
h1. UI návrh
93 25 Ondřej Váně
94 28 Ondřej Váně
* Návhr v PDF  "Zde":https://drive.google.com/open?id=1-IpTV9p6A5I20Y_y9zQyk8e-pg8Vzzol
95 26 Ondřej Váně
* Pokud chcete klikací verzi návrh UI, tak napište Ondřej Váně
96 29 Ondřej Váně
* Screeny níže
97
98 31 Ondřej Váně
h2. Home => /
99 1 Ondřej Váně
!screen_1.png!
100 31 Ondřej Váně
101
h2. Search => /search
102 1 Ondřej Váně
!screen_2.png!
103 31 Ondřej Váně
104
h2. Documents => /documents
105 1 Ondřej Váně
!screen_3.png!
106 31 Ondřej Váně
107
h2. About dialog => /
108 30 Ondřej Váně
!screen_4.png!
109 31 Ondřej Váně
110
h2. Help => /help
111 30 Ondřej Váně
!screen_5.png!