Komunikační protokol (v.1)¶

• Jednotlivé zprávy budou zasílány ve fromátu JSON
• Komunikace bude probíhat pomocí HTTP protokolu
• Budou využívány návratové HTTP kódy stavů (200, 400, 500, atd.)
• Návrh komunikace na obrázku níže.

REST API - URL¶

• /search: POST => hledání výrazu v dokumentech
• /documents: POST => přídání nového dokumentu a obrázku
• /documents: GET => vypsání všech dokumemtů (název, datum, atd.) jen základní info
• /documents/{název dokumentu}: GET => získání obrázku k danému dokumentu

• Struktura jednotlivých zpráv
  • Query request: /search : POST
    

    { 
        "query": "hledaný výraz", 
        "date": "čas odeslání dotazu" 
        "enableSpellCheck": "logická hodnota, která určuje, zda se používá spell check" 
    
    }
    

  • Query response: /search : POST
    

    {
       "exression":"hledaný výraz",
       "TextRegion":{
          "imageCut":"výřez dokumentu v Base64",
          "regionCoords": "koordináty regionu",
          "regionText":"text region",
          "documentName":"název dokumentu",
          "documentSize":"původní velikost oříznutého dokumentu",
          "randomId":"textový řtězec představující random id pro každý výsledek"  
          "textLines":[
             {
                "PlainText":"text line 1",
                "Coords":"koordináty řádky",
                "TextWord":[
                   {
                      "PlainText":"text word 1",
                      "Coords":"koordináty slova" 
                   }
                ]
             }
          ]
    
       }
    }