若要從產生的 OpenAPI 結構（也就是自動文件系統）中排除某個*路徑操作*，使用參數 `include_in_schema` 並將其設為 `False`：

{* ../../docs_src/path_operation_advanced_configuration/tutorial003_py310.py hl[6] *}

## 從 docstring 提供進階描述 { #advanced-description-from-docstring }

你可以限制 OpenAPI 從*路徑操作函式*的 docstring 中使用的內容行數。

加上一個 `\f`（跳頁字元，form feed）會讓 FastAPI 在此處截斷用於 OpenAPI 的輸出。

這個字元不會出現在文件中，但其他工具（例如 Sphinx）仍可使用其後的內容。

        @DisplayName("should reject invalid version formats")
        void shouldRejectInvalidVersionFormats(String version, String description) {
            assertFalse(
                    ModelVersionUtils.isValidModelVersion(version), "Should reject " + description + ": " + version);
        }

        private static Stream<Arguments> provideInvalidVersions() {
            return Stream.of(

    /**
     * Server supports directory leasing
     */
    public static final int SMB2_GLOBAL_CAP_DIRECTORY_LEASING = 0x20;

    /**
     * Server supports SMB3 encryption
     */
    public static final int SMB2_GLOBAL_CAP_ENCRYPTION = 0x40;

    /**
     * File information class
     */
    public static final byte SMB2_0_INFO_FILE = 1;

    /**

                                "Pre-Maven 4 legacy encrypted password detected for server " + server.getId()
                                        + " - configure password encryption with the help of mvnenc to be compatible with Maven 4.",
                                Severity.WARNING,
                                "server: " + server.getId(),
                                -1,

* `version`: A versão da sua API, por exemplo, `2.5.0`.
* `openapi_version`: A versão da especificação OpenAPI utilizada. Por padrão, a mais recente: `3.1.0`.
* `summary`: Um resumo curto da API.
* `description`: A descrição da sua API, que pode incluir markdown e será exibida na documentação.
* `routes`: Uma lista de rotas, que são cada uma das *operações de rota* registradas. Elas são obtidas de `app.routes`.

/// info | Informação

        setPrivateField(response, "commonCapabilities", 0);
        assertFalse(response.isDFSSupported());
    }

    @Test
    @DisplayName("Should check encryption support")
    void testIsEncryptionSupported() throws Exception {
        // Given
        setPrivateField(response, "supportsEncryption", true);

        // Then

        StringBuilder sb = new StringBuilder(512);
        boolean odd = true;
        sb.append(
                "<table border='1' class='zebra-striped'><tr class='a'><th><b>Options</b></th><th><b>Description</b></th></tr>");
        for (Option option : new CLIManagerExtension().getOptions()) {
            odd = !odd;
            sb.append("<tr class='");
            sb.append(odd ? 'a' : 'b');
            sb.append("'>");

     * Maximum length is 20 characters.
     */
    @Required
    @Size(max = 20)
    public String sessionId;

    /**
     * The name or description of the crawling session.
     * This is an optional descriptive field with a maximum length of 20 characters.
     */
    @Size(max = 20)
    public String name;

    /**

        promoteTask = branch.promoteNightlyTaskName(),
        triggerName = "ReadyforNightly",
    ) {
    init {
        id(NIGHTLY_SNAPSHOT_BUILD_ID)
        name = "Nightly Snapshot"
        description =
            "Promotes the latest successful changes on '${branch.branchName}' from Ready for Nightly as a new nightly snapshot"

        triggers {

            }
        }

        return serverKeys.toArray(new KerberosKey[0]);
    }

    /**
     * Retrieves a specific Kerberos key by key type.
     *
     * @param keyType the encryption type of the key to retrieve
     * @return the KerberosKey with the specified type, or null if not found
     */
    public KerberosKey getKey(int keyType) {
        KerberosKey serverKey = null;