forked from ktorio/ktor-documentation
-
Notifications
You must be signed in to change notification settings - Fork 0
/
lib.topic
321 lines (294 loc) · 11.5 KB
/
lib.topic
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic
SYSTEM "https://helpserver.labs.jb.gg/help/schemas/mvp/html-entities.dtd">
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://helpserver.labs.jb.gg/help/schemas/mvp/topic.v2.xsd" id="lib"
title="Library of Includes">
<snippet id="install_plugin">
<p>
To <a href="Plugins.md" anchor="install">install</a> the <code>%plugin_name%</code> plugin to the application,
pass it to the <code>install</code> function in the specified <a href="Modules.md">module</a>.
The code snippets below show how to install <code>%plugin_name%</code> ...
</p>
<list>
<li>
... inside the <code>embeddedServer</code> function call.
</li>
<li>
... inside the explicitly defined <code>module</code>, which is an extension function of the <code>Application</code> class.
</li>
</list>
<tabs>
<tab title="embeddedServer">
<code-block lang="kotlin">
import io.ktor.server.application.*
import %package_name%.*
// ...
fun main() {
embeddedServer(Netty, port = 8080) {
install(%plugin_name%)
// ...
}.start(wait = true)
}
</code-block>
</tab>
<tab title="module">
<code-block lang="kotlin">
import io.ktor.server.application.*
import %package_name%.*
// ...
fun Application.module() {
install(%plugin_name%)
// ...
}
</code-block>
</tab>
</tabs>
</snippet>
<snippet id="install_plugin_route">
<p>
The <code>%plugin_name%</code> plugin can also be <a href="Plugins.md" anchor="install-route">installed to specific routes</a>.
This might be useful if you need different <code>%plugin_name%</code> configurations for different application resources.
</p>
</snippet>
<snippet id="add_ktor_artifact_intro">
<p>
To use <code>%plugin_name%</code>, you need to include the <code>%artifact_name%</code> artifact in the build script:
</p>
</snippet>
<snippet id="add_ktor_client_artifact_tip">
<p>
You can learn more about artifacts required by the Ktor client from <a href="client-dependencies.md"/>.
</p>
</snippet>
<snippet id="add_ktor_artifact">
<tabs group="languages">
<tab title="Gradle (Kotlin)" group-key="kotlin">
<code-block lang="Kotlin">
implementation("io.ktor:%artifact_name%:$ktor_version")
</code-block>
</tab>
<tab title="Gradle (Groovy)" group-key="groovy">
<code-block lang="Groovy">
implementation "io.ktor:%artifact_name%:$ktor_version"
</code-block>
</tab>
<tab title="Maven" group-key="maven">
<code-block lang="XML">
<![CDATA[
<dependency>
<groupId>io.ktor</groupId>
<artifactId>%artifact_name%-jvm</artifactId>
<version>${ktor_version}</version>
</dependency>
]]>
</code-block>
</tab>
</tabs>
</snippet>
<snippet id="add_ktor_artifact_mpp">
<tabs group="languages">
<tab title="Gradle (Kotlin)" group-key="kotlin">
<code-block lang="Kotlin">
implementation("io.ktor:%artifact_name%:$ktor_version")
</code-block>
</tab>
<tab title="Gradle (Groovy)" group-key="groovy">
<code-block lang="Groovy">
implementation "io.ktor:%artifact_name%:$ktor_version"
</code-block>
</tab>
<tab title="Maven" group-key="maven">
<code-block lang="XML">
<![CDATA[
<dependency>
<groupId>io.ktor</groupId>
<artifactId>%artifact_name%%target%</artifactId>
<version>${ktor_version}</version>
</dependency>
]]>
</code-block>
</tab>
</tabs>
</snippet>
<snippet id="add_ktor_artifact_testing">
<tabs group="languages">
<tab title="Gradle (Kotlin)" group-key="kotlin">
<code-block lang="Kotlin">
testImplementation("io.ktor:%artifact_name%:$ktor_version")
</code-block>
</tab>
<tab title="Gradle (Groovy)" group-key="groovy">
<code-block lang="Groovy">
testImplementation "io.ktor:%artifact_name%:$ktor_version"
</code-block>
</tab>
<tab title="Maven" group-key="maven">
<code-block lang="XML">
<![CDATA[
<dependency>
<groupId>io.ktor</groupId>
<artifactId>%artifact_name%-jvm</artifactId>
<version>${ktor_version}</version>
</dependency>
]]>
</code-block>
</tab>
</tabs>
</snippet>
<snippet id="add_artifact">
<tabs group="languages">
<tab title="Gradle (Kotlin)" group-key="kotlin">
<code-block lang="Kotlin">
implementation("%group_id%:%artifact_name%:$%version%")
</code-block>
</tab>
<tab title="Gradle (Groovy)" group-key="groovy">
<code-block lang="Groovy">
implementation "%group_id%:%artifact_name%:$%version%"
</code-block>
</tab>
<tab title="Maven" group-key="maven">
<code-block lang="XML">
<![CDATA[
<dependency>
<groupId>%group_id%</groupId>
<artifactId>%artifact_name%</artifactId>
<version>${%version%}</version>
</dependency>
]]>
</code-block>
</tab>
</tabs>
</snippet>
<snippet id="add_artifact_testing">
<tabs group="languages">
<tab title="Gradle (Kotlin)" group-key="kotlin">
<code-block lang="Kotlin">
testImplementation("%group_id%:%artifact_name%:$%version%")
</code-block>
</tab>
<tab title="Gradle (Groovy)" group-key="groovy">
<code-block lang="Groovy">
testImplementation "%group_id%:%artifact_name%:$%version%"
</code-block>
</tab>
<tab title="Maven" group-key="maven">
<code-block lang="XML">
<![CDATA[
<dependency>
<groupId>%group_id%</groupId>
<artifactId>%artifact_name%</artifactId>
<version>${%version%}</version>
</dependency>
]]>
</code-block>
</tab>
</tabs>
</snippet>
<snippet id="add_ktor_artifact_multiplatform">
<tabs group="languages">
<tab title="Gradle (Kotlin)" group-key="kotlin">
<code-block lang="Kotlin">
val %platform_name%Main by getting {
dependencies {
implementation("io.ktor:%artifact_name%:$ktor_version")
}
}
</code-block>
</tab>
<tab title="Gradle (Groovy)" group-key="groovy">
<code-block lang="Groovy">
%platform_name%Main {
dependencies {
implementation "io.ktor:%artifact_name%:$ktor_version"
}
}
</code-block>
</tab>
</tabs>
</snippet>
<snippet id="outdated_warning">
<tip>
This help topic is in development and will be updated in the future.
</tip>
</snippet>
<snippet id="experimental">
<p>
The API is production ready, but may be slightly modified in a minor release. This is why it's marked with the
<code>@%annotation_name%</code> annotation. If you want to use this API, you need to <code>OptIn</code>:
</p>
<code-block lang="kotlin">
@OptIn(%annotation_name%::class)
</code-block>
<p>
If you want to leave your feedback or subscribe on updates, check out the <a href="https://youtrack.jetbrains.com/issue/KTOR-%issue_number%">KTOR-%issue_number%</a> design issue.
</p>
</snippet>
<snippet id="new_project_idea">
<p>
On the Welcome screen, click <control>New Project</control>.
</p>
<p>
Otherwise, from the main menu, select <ui-path>File | New | Project</ui-path>.
</p>
</snippet>
<snippet id="download_example">
<p>
<b>Code example</b>:
<a href="https://github.com/ktorio/ktor-documentation/tree/%ktor_version%/codeSnippets/snippets/%example_name%">
%example_name%
</a>
</p>
</snippet>
<snippet id="plugin_prerequisites">
<p>
Before starting this tutorial:
</p>
<list>
<li>
<p>
<a href="https://www.jetbrains.com/help/idea/installation-guide.html">Install IntelliJ IDEA Ultimate</a>.
</p>
<note>
<p>
If you use IntelliJ IDEA Community or other IDE, you can generate a Ktor project using a <a href="https://start.ktor.io/">web-based project generator</a>.
</p>
</note>
</li>
<li>
<p>
Make sure the <a href="https://www.jetbrains.com/help/idea/ktor.html">Ktor plugin</a> is installed and enabled.
</p>
</li>
</list>
</snippet>
<snippet id="client_prerequisites">
<p>
Before starting this tutorial:
</p>
<list>
<li>
<p>
<a href="https://www.jetbrains.com/help/idea/installation-guide.html">Install IntelliJ IDEA Community or Ultimate</a>.
</p>
</li>
<li>
<p>
Make sure the <a href="https://plugins.jetbrains.com/plugin/6954-kotlin">Kotlin</a> plugin is installed and enabled. Learn how to do this from the
<a href="https://www.jetbrains.com/help/idea/managing-plugins.html#open-plugin-settings">Install plugins</a> topic.
</p>
</li>
</list>
</snippet>
<snippet id="native_server_supported">
<p>
<b><a href="native_server.md">Native server</a> support</b>: ✅
</p>
</snippet>
<snippet id="native_server_not_supported">
<p>
<b><a href="native_server.md">Native server</a> support</b>: ✖️
</p>
</snippet>
</topic>