Generate Documentation

tapik includes a Markdown generator that turns discovered endpoint metadata into a lightweight API.md file.

Use it when you want a generated contract summary that can be published, diffed, or reviewed as part of your build output.

Enable the generator

tapik {
    markdownDocumentation { }
}

What it generates

The Markdown generator writes:

  • build/generated/API.md

The generated file groups endpoints by package and source file and includes:

  • endpoint ids and descriptions,

  • HTTP method and path,

  • URI parameter tables,

  • input header tables,

  • input body summaries,

  • output summaries, including headers and body shape.

What problem it solves

The Markdown generator is useful when you need a generated artifact that is easy to:

  • attach to a build,

  • review in pull requests,

  • publish into another documentation pipeline,

  • inspect without reading generated Kotlin.

It is especially helpful as a contract snapshot for teams that want something lighter than a full site generator.

How it relates to Dokka

The Markdown generator and Dokka do different jobs:

  • Dokka documents tapik’s Kotlin API surface,

  • API.md summarizes the endpoints discovered in your project.

One documents the library. The other documents your declared HTTP contract.

Boundaries

The Markdown generator is intentionally narrow. It does not replace a full user documentation site.

It does not:

  • explain user journeys,

  • teach your architecture,

  • add conceptual context beyond what the endpoint contract already says.

If you need narrative documentation, keep writing that separately and use API.md as a generated reference input.