Merge pull request #943 from diegotorrespy/master

KTLN-619: Added files and unit test for OpenAPI and Swagger

Author: ashleyfrieze

kotlin-ktor/src/main/java/com/baeldung/openapi/OpenAPIApplication.kt

@@ -0,0 +1,65 @@
+package com.baeldung.openapi
+
+import io.ktor.http.*
+import io.ktor.serialization.kotlinx.json.*
+import io.ktor.server.application.*
+import io.ktor.server.engine.*
+import io.ktor.server.netty.*
+import io.ktor.server.plugins.contentnegotiation.*
+import io.ktor.server.plugins.cors.routing.*
+import io.ktor.server.plugins.openapi.*
+import io.ktor.server.plugins.swagger.*
+import io.ktor.server.request.*
+import io.ktor.server.response.*
+import io.ktor.server.routing.*
+import io.swagger.codegen.v3.generators.html.StaticHtmlCodegen
+import kotlinx.serialization.Serializable
+import kotlinx.serialization.json.Json
+
+@Serializable
+data class Product(val id: Int, val name: String, val price: Double)
+
+fun main(args: Array<String>) {
+    embeddedServer(Netty, port = 8080, module = Application::main).start(wait = true)
+}
+
+fun Application.main() {
+    val productStorage = mutableListOf<Product>()
+    productStorage.addAll(
+        arrayOf(
+            Product(1, "Laptop", 999.99),
+            Product(2, "Smartphone", 499.99)
+        )
+    )
+
+    install(ContentNegotiation) {
+        json(Json {
+            prettyPrint = true
+            isLenient = true
+        })
+    }
+    install(CORS) {
+        anyHost()
+        allowHeader(HttpHeaders.ContentType)
+    }
+    routing {
+        get("/product/{id}") {
+            val id = call.parameters["id"]
+            val product: Product = productStorage.find { it.id == id!!.toInt() }!!
+            call.respond(product)
+        }
+
+        post("/product") {
+            val product = call.receive<Product>()
+            productStorage.add(product)
+            call.respondText("Product saved successfully", status = HttpStatusCode.Created)
+        }
+
+        swaggerUI(path = "swagger", swaggerFile = "openapi/documentation.yaml") {
+            version = "4.15.5"
+        }
+        openAPI(path="openapi", swaggerFile = "openapi/documentation.yaml") {
+            codegen = StaticHtmlCodegen()
+        }
+    }
+}

kotlin-ktor/src/main/resources/openapi/documentation.yaml

@@ -0,0 +1,57 @@
+openapi: "3.0.3"
+info:
+  title: "Products API"
+  description: "API to create and retrieve Products"
+  version: "1.0.0"
+servers:
+  - url: "http://0.0.0.0:8080"
+paths:
+  /product:
+    post:
+      description: "Creates a new product"
+      requestBody:
+        description: "A JSON object that represents a product"
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/Product"
+      responses:
+        "201":
+          description: "Created"
+          content:
+            text/plain:
+              schema:
+                type: "string"
+              examples:
+                Example#1:
+                  value: "Product saved successfully"
+  /product/{id}:
+    get:
+      description: "Returns a product by the ID"
+      parameters:
+        - name: "id"
+          in: "path"
+          required: true
+          schema:
+            type: "string"
+      responses:
+        "200":
+          description: "OK"
+          content:
+            '*/*':
+              schema:
+                $ref: "#/components/schemas/Product"
+components:
+  schemas:
+    Product:
+      type: "object"
+      properties:
+        id:
+          type: "integer"
+          format: "int32"
+        name:
+          type: "string"
+        price:
+          type: "number"
+          format: "double"

kotlin-ktor/src/test/java/com/baeldung/openapi/OpenAPIApplicationTest.kt

@@ -0,0 +1,60 @@
+import com.baeldung.openapi.Product
+import io.ktor.client.plugins.contentnegotiation.*
+import io.ktor.client.request.*
+import io.ktor.client.statement.*
+import io.ktor.http.*
+import io.ktor.serialization.kotlinx.json.*
+import io.ktor.server.testing.*
+import org.junit.After
+import java.io.File
+import kotlin.test.Test
+import kotlin.test.assertEquals
+
+class ProductTests {
+    @Test
+    fun testSwaggerUIStatus() = testApplication {
+        val response = client.get("/swagger")
+        assertEquals(HttpStatusCode.OK, response.status)
+    }
+
+    @Test
+    fun testOpenApiStatus() = testApplication {
+        val response = client.get("/openapi")
+        assertEquals(HttpStatusCode.OK, response.status)
+    }
+
+    @Test
+    fun testGetProduct() = testApplication {
+        val response = client.get("/product/1")
+        assertEquals(
+            """
+                {
+                    "id": 1,
+                    "name": "Laptop",
+                    "price": 999.99
+                }
+            """.trimIndent(), response.bodyAsText()
+        )
+        assertEquals(HttpStatusCode.OK, response.status)
+    }
+
+    @Test
+    fun testPostProduct() = testApplication {
+        val client = createClient {
+            install(ContentNegotiation) {
+                json()
+            }
+        }
+        val response = client.post("/product") {
+            contentType(ContentType.Application.Json)
+            setBody(Product(3, "Tablet", 299.99))
+        }
+        assertEquals("Product stored correctly", response.bodyAsText())
+        assertEquals(HttpStatusCode.Created, response.status)
+    }
+
+    @After
+    fun deleteDocsDir() {
+        File("docs").deleteRecursively()
+    }
+}