Basic
This example shows a basic usage of the plugin
| Basics.kt |
|---|
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 | package io.github.smiley4.ktoropenapi.examples
import io.github.smiley4.ktoropenapi.OpenApi
import io.github.smiley4.ktoropenapi.config.OutputFormat
import io.github.smiley4.ktoropenapi.get
import io.github.smiley4.ktoropenapi.openApi
import io.github.smiley4.ktorredoc.redoc
import io.github.smiley4.ktorswaggerui.swaggerUI
import io.ktor.http.HttpStatusCode
import io.ktor.server.application.Application
import io.ktor.server.application.install
import io.ktor.server.engine.embeddedServer
import io.ktor.server.netty.Netty
import io.ktor.server.response.respondText
import io.ktor.server.routing.route
import io.ktor.server.routing.routing
fun main() {
embeddedServer(Netty, port = 8080, host = "localhost", module = Application::myModule).start(wait = true)
}
private fun Application.myModule() {
// Install and configure the "OpenApi" Plugin
install(OpenApi) {
outputFormat = OutputFormat.JSON
// configure basic information about the api
info {
title = "Example API"
description = "An example api to showcase basic swagger-ui functionality."
}
// provide a reference to an external documentation
externalDocs {
url = "https://github.com/SMILEY4/ktor-swagger-ui/wiki"
description = "Sample external documentation"
}
// configure the servers from where the api is being served
server {
url = "http://localhost:8080"
description = "Development Server"
}
server {
url = "https://www.example.com"
description = "Production Server"
}
}
routing {
// Create a route for the openapi spec file.
// This route will not be included in the spec.
route("api.json") {
openApi()
}
// Create a route for the Swagger UI using the openapi spec at "/api.json".
// This route will not be included in the spec.
route("swagger") {
swaggerUI("/api.json")
}
// Create a route for redoc using the OpenAPI spec at "/api.json".
// This route will not be included in the spec.
route("redoc") {
redoc("/api.json")
}
// a documented route
get("hello", {
// description of the route
description = "A Hello-World route"
// information about the request
request {
// information about the query parameter "name" of type "string"
queryParameter<String>("name") {
description = "the name to greet"
}
}
// information about possible responses
response {
// information about a "200 OK" response
code(HttpStatusCode.OK) {
// a description of the response
description = "successful request - always returns 'Hello World!'"
}
}
}) {
call.respondText("Hello ${call.request.queryParameters["name"]}")
}
}
}
|