Skip to content

feat: add Kotlin API references overview #4807

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

feat: add Kotlin API references overview #4807

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3de0fe2
feat: add Kotlin API references overview
koshachy Apr 15, 2025
4a975b0
feat: add Kotlin API references overview
koshachy Apr 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/images/social/github.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/kr.tree
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -308,6 +308,7 @@
<toc-element toc-title="Ktor" href="https://ktor.io/"/>
</toc-element>
<toc-element toc-title="API reference">
<toc-element toc-title="Overview" topic="api-references.md"/>
<toc-element toc-title="Standard library (stdlib)" href="https://kotlinlang.org/api/latest/jvm/stdlib/"/>
<toc-element toc-title="Test library (kotlin.test)" href="https://kotlinlang.org/api/latest/kotlin.test/"/>
<toc-element toc-title="Coroutines (kotlinx.coroutines)" href="https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/"/>
Expand Down
77 changes: 77 additions & 0 deletions docs/topics/api-references.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
[//]: # (title: API References)

Welcome to the Kotlin API References page. Here you'll find links to the API documentation for the official Kotlin libraries and tools.

<table style="none" border="false">
<tr>
<td>
<a href="https://kotlinlang.org/api/latest/jvm/stdlib/"><b>Standard library (stdlib)</b></a>
<br/>
<img src="github.svg" width="18"/> <a href="https://github.com/JetBrains/kotlin">kotlin</a>
<p>The Kotlin Standard Library provides essential functions and types for Kotlin programming, including collections, text processing, I/O operations, and more.</p>
</td>
<td>
<a href="https://kotlinlang.org/api/latest/kotlin.test/"><b>Test library (kotlin.test)</b></a>
<br/>
<img src="github.svg" width="18"/> <a href="https://github.com/JetBrains/kotlin">kotlin</a>
<p>A library that provides annotations and utility functions for testing Kotlin code across all platforms.</p>
</td>
</tr>

<tr>
<td>
<a href="https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/"><b>Coroutines (kotlinx.coroutines)</b></a>
<br/>
<img src="github.svg" width="18"/> <a href="https://github.com/Kotlin/kotlinx.coroutines">kotlinx.coroutines</a>
<p>A rich library for coroutines that provides high-level coroutine-enabled primitives for asynchronous programming.</p>
</td>
<td>
<a href="https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-core/"><b>Serialization (kotlinx.serialization)</b></a>
<br/>
<img src="github.svg" width="18"/> <a href="https://github.com/Kotlin/kotlinx.serialization">kotlinx.serialization</a>
<p>A multiplatform library for structured data serialization and deserialization, supporting various formats like JSON, CBOR, and Protocol Buffers.</p>
</td>
</tr>

<tr>
<td>
<a href="https://kotlinlang.org/api/kotlinx-io/"><b>Kotlin I/O library (kotlinx-io)</b></a>
<br/>
<img src="github.svg" width="18"/> <a href="https://github.com/Kotlin/kotlinx-io">kotlinx-io</a>
<p>A multiplatform library for working with binary data, providing primitives for reading and writing binary data across all Kotlin platforms.</p>
</td>
<td>
<a href="https://kotlinlang.org/api/kotlinx-datetime/"><b>Date and time (kotlinx-datetime)</b></a>
<br/>
<img src="github.svg" width="18"/> <a href="https://github.com/Kotlin/kotlinx-datetime">kotlinx-datetime</a>
<p>A multiplatform library for working with dates and times, providing a consistent API across all Kotlin platforms.</p>
</td>
</tr>

<tr>
<td>
<a href="https://kotlinlang.org/api/kotlinx-metadata-jvm/"><b>JVM Metadata (kotlin-metadata-jvm)</b></a>
<br/>
<img src="github.svg" width="18"/> <a href="https://github.com/JetBrains/kotlin/tree/master/libraries/kotlinx-metadata">kotlinx-metadata</a>
<p>A library for reading and writing Kotlin metadata in JVM class files, useful for annotation processors and other tools.</p>
</td>
<td>
<a href="https://api.ktor.io/"><b>Ktor</b></a>
<br/>
<img src="github.svg" width="18"/> <a href="https://github.com/ktorio/ktor">ktor</a>
<p>A framework for building asynchronous servers and clients in connected systems using Kotlin, designed with coroutines for high performance.</p>
</td>
</tr>

<tr>
<td>
<a href="https://kotlinlang.org/api/kotlin-gradle-plugin/"><b>Kotlin Gradle plugins (kotlin-gradle-plugin)</b></a>
<br/>
<img src="github.svg" width="18"/> <a href="https://github.com/JetBrains/kotlin/tree/master/libraries/tools/kotlin-gradle-plugin">kotlin-gradle-plugin</a>
<p>Gradle plugins for Kotlin projects, providing build automation and dependency management for Kotlin applications.</p>
</td>
<td>
</td>
</tr>

</table>