ReVanced/revanced-api
1
0
Fork 0
mirror of https://github.com/ReVanced/revanced-api.git synced 2026-01-24 11:41:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat: Add OpenAPI docs and cache to routes

Browse Source
This commit is contained in:
oSumAtrIX
2024-06-09 01:28:33 +02:00
parent 205bcde77a
commit 6ea63be490
14 changed files with 592 additions and 124 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
src/main/kotlin/app/revanced/api/configuration/OpenAPI.kt Normal file
View File

@@ -0,0 +1,52 @@
package app.revanced.api.configuration
import app.revanced.api.command.applicationVersion
import io.bkbn.kompendium.core.plugin.NotarizedApplication
import io.bkbn.kompendium.json.schema.KotlinXSchemaConfigurator
import io.bkbn.kompendium.oas.OpenApiSpec
import io.bkbn.kompendium.oas.component.Components
import io.bkbn.kompendium.oas.info.Contact
import io.bkbn.kompendium.oas.info.Info
import io.bkbn.kompendium.oas.info.License
import io.bkbn.kompendium.oas.security.BasicAuth
import io.bkbn.kompendium.oas.security.BearerAuth
import io.bkbn.kompendium.oas.server.Server
import io.ktor.server.application.*
import java.net.URI
internal fun Application.configureOpenAPI() {
install(NotarizedApplication()) {
spec = {
OpenApiSpec(
info = Info(
title = "Revanced API",
version = applicationVersion,
description = "API server for ReVanced.",
contact = Contact(
name = "ReVanced",
url = URI("https://revanced.app"),
email = "contact@revanced.app",
),
license = License(
name = "AGPLv3",
url = URI("https://github.com/ReVanced/revanced-api/blob/main/LICENSE"),
),
),
components = Components(
securitySchemes = mutableMapOf(
"bearer" to BearerAuth(),
"basic" to BasicAuth(),
),
),
).apply {
servers += Server(
url = URI("https://api.revanced.app"),
description = "ReVanced API server.",
)
}
}
schemaConfigurator = KotlinXSchemaConfigurator()
}
}