### Interaktive API-Dokumentation { #interactive-api-docs }

Gehen Sie nun auf <a href="http://127.0.0.1:8000/docs" class="external-link" target="_blank">http://127.0.0.1:8000/docs</a>.

Sie sehen die automatische interaktive API-Dokumentation (bereitgestellt von <a href="https://github.com/swagger-api/swagger-ui" class="external-link" target="_blank">Swagger UI</a>):

    "description": 'Create an invoice.\n\nThis will (let\'s imagine) let the API user (some external developer) create an\ninvoice.\n\nAnd this path operation will:\n\n* Send the invoice to the client.\n* Collect the money from the client.\n* Send a notification back to the API user (the external developer), as a callback.\n    * At this point is that the API will somehow send a POST request to the\n        external API with the notification of the invoice event\n        (e.g. "payment successful").',...

        api("commons-io:commons-io:2.14.0")
        api("org.apache.commons:commons-lang3:3.20.0")
        api("javax.activation:activation:1.1.1")
        api("jakarta.xml.bind:jakarta.xml.bind-api:4.0.2")
        api("com.sun.xml.bind:jaxb-impl:4.0.5")
        api("junit:junit:4.13.2")
        api("org.spockframework:spock-core:$spockVersion")
        api("org.spockframework:spock-junit4:$spockVersion")

    "description": 'Create an invoice.\n\nThis will (let\'s imagine) let the API user (some external developer) create an\ninvoice.\n\nAnd this path operation will:\n\n* Send the invoice to the client.\n* Collect the money from the client.\n* Send a notification back to the API user (the external developer), as a callback.\n    * At this point is that the API will somehow send a POST request to the\n        external API with the notification of the invoice event\n        (e.g. "payment successful").',...

import common.VersionedSettingsBranch
import org.junit.jupiter.api.Assertions.assertEquals
import org.junit.jupiter.api.Assertions.assertNull
import org.junit.jupiter.params.ParameterizedTest
import org.junit.jupiter.params.provider.CsvSource
import org.junit.jupiter.params.provider.ValueSource
import promotion.determineNightlyPromotionTriggerHour

/*
 * Copyright 2023 the original author or authors.
 *

import japicmp.model.JApiChangeStatus
import me.champeau.gradle.japicmp.JapicmpTask
import me.champeau.gradle.japicmp.report.RichReport
import org.gradle.api.Action
import org.gradle.api.Project
import org.gradle.api.file.Directory
import org.gradle.api.file.FileCollection

class BinaryCompatibilityHelper {
    static setupJApiCmpRichReportRules(
        JapicmpTask japicmpTask,
        Project project,

Daher müssen Sie möglicherweise weiterhin Pydantic-Modelle verwenden.

Wenn Sie jedoch eine Menge Datenklassen herumliegen haben, ist dies ein guter Trick, um sie für eine Web-API mithilfe von FastAPI zu verwenden. 🤓

///

## Datenklassen in `response_model` { #dataclasses-in-response-model }

Sie können `dataclasses` auch im Parameter `response_model` verwenden:

///

## Dataclasses in `response_model` { #dataclasses-in-response-model }

You can also use `dataclasses` in the `response_model` parameter:

{* ../../docs_src/dataclasses_/tutorial002_py310.py hl[1,6:12,18] *}

The dataclass will be automatically converted to a Pydantic dataclass.

This way, its schema will show up in the API docs user interface:

// https://github.com/gradle/gradle-private/issues/4528
// Trigger ReadyForNightly and ReadyForRelease for provider-api-migration/public-api-changes branch
// TODO: remove this after the branch is merged
const val PROVIDER_API_MIGRATION_BRANCH = "provider-api-migration/public-api-changes"
const val BOT_DAILY_UPGRADLE_WRAPPER_BRANCH = "devprod/upgrade-to-latest-wrapper"

const val DEPENDABOT_BRANCH_PATTERN = "dependabot/*"

                artifact()
            }
            content {
                includeModule('gradle', 'gradle')
            }
        }
    }
}

// We support multiple accepted public api changes JSON files, but "accepted-public-api-changes.json"
// is the "main" one that is also shown in HTML report
def apiChangesJsonDirectory = layout.projectDirectory.dir("src/changes/accepted-changes")