Automated API documentation for Ktor/JVM servers
Вы не можете выбрать более 25 тем Темы должны начинаться с буквы или цифры, могут содержать дефисы(-) и должны содержать не более 35 символов.
James Fenn d137f09e7c add demo screenshots to readme 5 месяцев назад
.meta/images add demo screenshots to readme 5 месяцев назад
docs add license 5 месяцев назад
example add license 5 месяцев назад
gradle/wrapper initial commit 5 месяцев назад
.gitignore add demo screenshots to readme 5 месяцев назад
LICENSE add license 5 месяцев назад add demo screenshots to readme 5 месяцев назад
build.gradle initial commit 5 месяцев назад add auth config options 5 месяцев назад
gradlew initial commit 5 месяцев назад
gradlew.bat initial commit 5 месяцев назад
settings.gradle initial commit 5 месяцев назад

Ktor-Docs JitPack Discord

This library automatically generates REST API documentation for Ktor/JVM projects and hosts it under a specified URL.


Endpoint Auth Info
img img


The :docs module is published on JitPack, which you can add to your project by copying the following to your root build.gradle at the end of "repositories".

allprojects {
  repositories {
    maven { url '' }

To add the dependency to a module, copy this line into your program's build.gradle file.

implementation "dev.horrific.code.james:ktordocs:$ktordocs_version"


First, you must install the ktor feature - replacing the default configuration with your project's values.

install(RestDocsFeature) {
    baseUrl = ""
    title = "Example API"
    desc = "Basic documentation generated for testing & demo purposes."

Documentation can then be specified in any endpoint/request handler by invoking the docs() function at the start of its callback. (this function will not do anything during normal requests, and should not have any effect on performance)

get("/api/v1/example") {
    docs {
        title = "Hello World"
        desc = "Says hello to the world."

    call.respondText("Hello world!")

Finally, choose a location to host the documentation at using restDocumentation(path)

route("/api") {

Endpoint Parameters

The library will automatically generate a list of URL parameters by parsing the endpoint URL - however, more information can be specified using the param(...) function...

get("/api/user/{username}") {
    docs {
        param("username") { // a URL property
            type = "SHA1 hash"
            desc = "A unique identifier of a user."
        param("fetchAll") { // a query parameter (/?fetchAll=true)
            type = "boolean"
            desc = "Whether to fetch all user information from external sources."
            location = ParameterInfo.In.Query

    // ...

Endpoint Responses

Some endpoints may return different information depending on the response status - such as an error handler or authentication state. This can be specified using the responds() function.

get("/api/user/{username}") {
    docs {
        responds { // default response behavior (200 OK)
            desc = "If the user has been found."

            // this is a handy function to set the `example` property
            // if your response uses a JSON serializer
        responds(HttpStatusCode.NotFound) {
            desc = "If the user doesn't exist."
            example = """{ "message": "Unable to locate the requested user." }"""

    // ...

Endpoints can reference URL links as supporting material, which are provided in a list on the documentation page.

get("/api/user/{username}") {
    docs {
        reference("", "Example Link")

    // ...


The project uses Gradle builds for... err... most things. ./gradlew :{module}:test and ./gradle :{module}:run are fairly universal.


Copyright (c) 2020 James Fenn

This Source Code Form is subject to the terms of the Mozilla Public
License, v. 2.0. If a copy of the MPL was not distributed with this
file, You can obtain one at