| Nils Diewald | a31a515 | 2015-04-17 21:05:23 +0000 | [diff] [blame] | 1 | % layout 'main', title => 'KorAP: Application Programming Interface'; |
| 2 | |
| Akron | 9490e3b | 2019-10-17 12:26:29 +0200 | [diff] [blame] | 3 | %= page_title |
| Nils Diewald | a31a515 | 2015-04-17 21:05:23 +0000 | [diff] [blame] | 4 | |
| Akron | 07d166a | 2019-07-17 17:21:29 +0200 | [diff] [blame] | 5 | <p>Internally the communication between KorAP components is done using the KoralQuery protocol. |
| Akron | 9490e3b | 2019-10-17 12:26:29 +0200 | [diff] [blame] | 6 | The specification for KoralQuery is available on <%= ext_link_to 'GitHub', "http://korap.github.io/Koral" %>. |
| Akron | 07d166a | 2019-07-17 17:21:29 +0200 | [diff] [blame] | 7 | All API endpoints either use KoralQuery or are (more or lest) REST-ful web APIs.</p> |
| Nils Diewald | a31a515 | 2015-04-17 21:05:23 +0000 | [diff] [blame] | 8 | |
| Helge | 23f7abd | 2024-02-27 16:35:15 +0100 | [diff] [blame] | 9 | <p>All publicly available API endpoints (partially experimental) including their requests and responses are described in the <%= ext_link_to 'GitHub Wiki', "https://github.com/KorAP/Kustvakt/wiki" %> of <%= embedded_link_to 'doc', 'Kustvakt', 'korap', 'kustvakt' %>.</p> |
| Akron | 07d8de6 | 2020-02-04 17:45:40 +0100 | [diff] [blame] | 10 | |
| Akron | 8a21b4d | 2020-04-16 16:17:42 +0200 | [diff] [blame] | 11 | % my $api_url = $c->url_for('proxy' => (apiv => $Kalamar::API_VERSION))->to_abs->scheme('https'); |
| 12 | % $api_url->path->trailing_slash(1); |
| Helge | 23f7abd | 2024-02-27 16:35:15 +0100 | [diff] [blame] | 13 | |
| 14 | %if ($c->app->config('Kalamar')->{openapi}) { |
| 15 | <p id="openapi"> |
| 16 | % my $openapi= $api_url->to_abs; |
| 17 | % $openapi->path->merge($c->app->config('Kalamar')->{openapi})->trailing_slash(1); |
| 18 | The OpenAPI documentation is described <%= ext_link_to 'here', $openapi %>. |
| 19 | </p> |
| 20 | % } |
| 21 | |
| Akron | 07d8de6 | 2020-02-04 17:45:40 +0100 | [diff] [blame] | 22 | <p>The root service can be found at <code id="api-service-uri"><%= $api_url %></code>.</p> |