| Rebecca Wilm | 6b4d374 | 2025-05-06 10:33:23 +0200 | [diff] [blame] | 1 | % layout 'main', title => 'KorAP: Application Programming Interface'; |
| 2 | |
| 3 | %= page_title |
| 4 | |
| 5 | <p>Die Kommunikation zwischen KorAP-Komponenten wird intern über das KoralQuery-Protokoll geregelt. Die Spezifikation für KoralQuery ist auf <%= ext_link_to 'GitHub', "http://korap.github.io/Koral" %> verfügbar. Alle API-Endpunkte nutzen entweder KoralQuery oder sind (mehr oder weniger) RESTful-Web-APIs.</p> |
| 6 | |
| 7 | <p>Alle (teilweise experimentellen) öffentlich verfügbaren API-Endpunkte inklusive ihrer Anfragen und Antworten sind im <%= ext_link_to 'GitHub-Wiki', "https://github.com/KorAP/Kustvakt/wiki" %> von <%= embedded_link_to 'doc', 'Kustvakt', 'korap', 'kustvakt' %> beschrieben.</p> |
| 8 | |
| Helge | 66692d9 | 2026-02-23 10:41:34 +0100 | [diff] [blame^] | 9 | % my $api_version = $c->app->config('Kalamar')->{api_version}; |
| 10 | % my $api_url = $c->url_for('proxy' => (apiv => $api_version))->to_abs->scheme('https'); |
| Rebecca Wilm | 6b4d374 | 2025-05-06 10:33:23 +0200 | [diff] [blame] | 11 | % $api_url->path->trailing_slash(1); |
| 12 | |
| 13 | %if ($c->app->config('Kalamar')->{openapi}) { |
| 14 | <p id="openapi"> |
| 15 | % my $openapi= $api_url->to_abs; |
| 16 | % $openapi->path->merge($c->app->config('Kalamar')->{openapi})->trailing_slash(1); |
| 17 | Die OpenAI-Dokumentation befindet sich <%= ext_link_to 'hier', $openapi %>. |
| 18 | </p> |
| 19 | % } |
| 20 | |
| 21 | <p>Der Root-Service ist unter <code id="api-service-uri"><%= $api_url %></code> zu finden.</p> |
| 22 | |
| 23 | <h2>Client-Bibliotheken</h2> |
| 24 | |
| 25 | <p>Client-Bibliotheken sind für R auf <%= ext_link_to 'CRAN', 'https://cran.r-project.org/package=RKorAPClient' %> (Quellcode und weitere Informationen auf <%= ext_link_to 'GitHub', 'https://github.com/KorAP/RKorAPClient' %>) und für Python auf <%= ext_link_to 'PyPI', 'https://pypi.org/project/KorAPClient/' %> (Quellcode auf <%= ext_link_to 'GitHub', 'https://github.com/KorAP/PythonKorAPClient' %>) verfügbar.</p> |