ktor-documentation/topics/welcome.topic at ce6d9e3097565e2fb52d13dbbfc1d0dde8957a09 · ktorio/ktor-documentation · GitHub

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
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic SYSTEM "https://resources.jetbrains.com/writerside/1.0/html-entities.dtd">

<topic xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       title="Welcome"
       id="welcome">
    <section-starting-page>
        <title>Ktor Documentation</title>
        <description>
            Ktor is a framework for building asynchronous server-side and client-side applications with ease.
        </description>

        <spotlight>
            <card href="server-create-a-new-project.topic" badge="server"
                  summary="Learn how to create, run and test a server application with Ktor.">
                Get started with Ktor Server
            </card>
            <card href="client-create-new-application.topic" badge="cross-platform"
                  summary="Learn how to create, run and test a client application with Ktor.">
                Get started with Ktor Client
            </card>
        </spotlight>

        <primary>
            <title>Ktor Server</title>
            <card href="server-requests-and-responses.topic">
                Handle requests and generate responses
            </card>
            <card href="server-create-restful-apis.topic">Create a RESTful API</card>
            <card href="server-create-website.topic">Create a website</card>
            <card href="server-create-websocket-application.topic">
                Create a WebSocket application
            </card>
            <card href="server-integrate-database.topic">Integrate a database</card>
        </primary>
        <misc>
            <links narrow="true">
                <group>
                    <title>Server configuration</title>
                    <a href="server-create-a-new-project.topic"/>
                    <a href="server-dependencies.topic"/>
                    <a href="server-create-and-configure.topic"/>
                    <a href="server-configuration-code.topic"/>
                    <a href="server-configuration-file.topic"/>
                    <a href="server-plugins.md"/>
                </group>
                <group>
                    <title>Routing</title>
                    <a href="server-routing.md"/>
                    <a href="server-resources.md"/>
                    <a href="server-routing-organization.md"/>
                    <a href="server-requests.md"/>
                    <a href="server-responses.md"/>
                    <a href="server-static-content.md"/>
                </group>
                <group>
                    <title>Plugins</title>
                    <a href="server-serialization.md"/>
                    <a href="server-templating.md"/>
                    <a href="server-auth.md"/>
                    <a href="server-sessions.md"/>
                    <a href="server-websockets.md"/>
                    <a href="server-server-sent-events.topic"/>
                    <a href="server-swagger-ui.md"/> / <a href="server-openapi.md"/>
                    <a href="server-custom-plugins.md"/>
                </group>
                <group>
                    <title>Run, debug and test</title>
                    <a href="server-run.md"/>
                    <a href="server-auto-reload.topic"/>
                    <a href="server-testing.md"/>
                </group>
                <group>
                    <title>Deployment</title>
                    <a href="server-fatjar.md">Creating Fat JARs</a>
                    <a href="server-war.md"/>
                    <a href="graalvm.md"/>
                    <a href="docker.md"/>
                    <a href="google-app-engine.md"/>
                    <a href="heroku.md"/>
                    <a href="sevalla.md"/>
                </group>
            </links>
            <cards>
                <title>Ktor Client</title>
                <card href="client-create-new-application.topic"
                      summary="Create a client application with Ktor.">
                    Create a client application
                </card>
                <card href="client-create-multiplatform-application.md"
                      summary="Create a Kotlin Multiplatform Mobile application and learn how to make requests and receive responses with the Ktor Client.">
                    Create a cross-platform mobile application
                </card>
            </cards>
            <links narrow="true">
                <group>
                    <title>Client setup</title>
                    <a href="client-create-new-application.topic"/>
                    <a href="client-dependencies.md"/>
                    <a href="client-create-and-configure.md"/>
                    <a href="client-engines.md"/>
                    <a href="client-plugins.md"/>
                </group>
                <group>
                    <title>Requests</title>
                    <a href="client-requests.md"/>
                    <a href="client-resources.md"/>
                    <a href="client-default-request.md"/>
                    <a href="client-request-retry.md"/>
                </group>
                <group>
                    <title>Responses</title>
                    <a href="client-responses.md"/>
                    <a href="client-response-validation.md"/>
                </group>
                <group>
                    <title>Plugins</title>
                    <a href="client-auth.md"/>
                    <a href="client-cookies.md"/>
                    <a href="client-content-encoding.md"/>
                    <a href="client-bom-remover.md"/>
                    <a href="client-caching.md"/>
                    <a href="client-websockets.topic"/>
                    <a href="client-server-sent-events.topic"/>
                    <a href="client-custom-plugins.md"/>
                </group>
                <group>
                    <title>Testing</title>
                    <a href="client-testing.md"/>
                </group>
            </links>
            <cards>
                <title>Integrations</title>
                <card href="full-stack-development-with-kotlin-multiplatform.topic"/>
                <card href="tutorial-first-steps-with-kotlin-rpc.topic"/>
            </cards>
        </misc>

    </section-starting-page>
</topic>