* `description`: `str` з коротким описом зовнішньої документації.
    * `url` (**обов'язково**): `str` з URL-адресою зовнішньої документації.

### Створення метаданих для тегів { #create-metadata-for-tags }

Спробуймо це на прикладі з тегами для `users` та `items`.

Створіть метадані для своїх тегів і передайте їх у параметр `openapi_tags`:

{* ../../docs_src/metadata/tutorial004_py310.py hl[3:16,18] *}

    }

    private void configurePublications(Project project) {
        var publishingExtension = project.getExtensions().getByType(PublishingExtension.class);
        var publication = publishingExtension.getPublications().create("elastic", MavenPublication.class);
        project.afterEvaluate(project1 -> {
            if (project1.getPlugins().hasPlugin(ShadowPlugin.class)) {
                configureWithShadowPlugin(project1, publication);

                buf.append(cpSeparator);
                buf.append(basePath);
                buf.append(file.getName());
            }
        }
    }

    /**
     * Creates a timeout task for this job execution.
     * If timeout is not set or is <= 0, returns null.
     *
     * @return the timeout task, or null if no timeout is configured
     */

 * to perform its tasks.
 *
 * <p>The crawling process involves the following steps:
 * <ol>
 *   <li>Initialization: Sets up the crawler context and initializes the URL filter.</li>
 *   <li>Thread Creation: Creates a group of crawler threads to perform the actual crawling.</li>
 *   <li>Execution: Starts the crawler threads and waits for them to complete.</li>
 *   <li>Cleanup: Deletes the crawled data and clears the URL filter.</li>
 * </ol>

            // Given: Original value that fits in byte range
            int originalValue = 150;
            NdrShort ndrShort1 = new NdrShort(originalValue);

            // Create separate mocks for encoding and decoding to simulate real buffer
            NdrBuffer encodeBuffer = mock(NdrBuffer.class);
            NdrBuffer decodeBuffer = mock(NdrBuffer.class);

当然，这并不是最优的做法，您不应该在生产环境中使用它。

在生产环境中，您应该选择上述任一选项。

但这是一种专注于 WebSockets 的服务器端并提供一个工作示例的最简单方式：

{* ../../docs_src/websockets_/tutorial001_py310.py hl[2,6:38,41:43] *}

## 创建 `websocket` { #create-a-websocket }

在您的 **FastAPI** 应用程序中，创建一个 `websocket`：

{* ../../docs_src/websockets_/tutorial001_py310.py hl[1,46:47] *}

/// note | 技术细节

您也可以使用 `from starlette.websockets import WebSocket`。

            FileOutputStream fos;
            try {
                fos = new FileOutputStream(this.outputFile);
            } catch (IOException e) {
                throw new UncheckedIOException("Unable to create test suite output file", e);
            }

            this.writer = new PrintWriter(new BufferedOutputStream(fos));
        }

        public void write(TestOutputEvent event) {
            String prefix;

  }

  /**
   * Creates a {@link PairedStats} from with the given lists of {@code x} and {@code y} values,
   * which must be of the same size.
   */
  static PairedStats createPairedStatsOf(List<Double> xValues, List<Double> yValues) {
    return createFilledPairedStatsAccumulator(xValues, yValues).snapshot();
  }

  /**

 *   <li><b>Null-hostility.</b> This collection will never contain a null element.
 *   <li><b>Deterministic iteration.</b> The iteration order is always well-defined, depending on
 *       how the collection was created. Typically this is insertion order unless an explicit
 *       ordering is otherwise specified (e.g. {@link ImmutableSortedSet#naturalOrder}). See the
 *       appropriate factory method for details. View collections such as {@link

API を OAuth2 プロバイダと統合すると、認証を実行して取得したクレデンシャルを持った状態で API ドキュメントに戻れます。そして実際の OAuth2 認証を用いてドキュメント上から API と対話できます。

Swagger UI がこの処理を裏側で行いますが、そのためにこの「redirect」の補助が必要です。

///

### テスト用の *path operation* を作成 { #create-a-path-operation-to-test-it }

すべてが動作するかをテストできるように、*path operation* を作成します:

{* ../../docs_src/custom_docs_ui/tutorial001_py310.py hl[36:38] *}

### テスト { #test-it }