Теперь вы можете создать *операции пути* для пользовательской документации.

Вы можете переиспользовать внутренние функции FastAPI для создания HTML-страниц документации и передать им необходимые аргументы:

* `openapi_url`: URL, по которому HTML-страница документации сможет получить схему OpenAPI для вашего API. Здесь можно использовать атрибут `app.openapi_url`.
* `title`: заголовок вашего API.

///

/// note | Технічні деталі

Будь-яка функція, яку можна використовувати з:

* [`@contextlib.contextmanager`](https://docs.python.org/3/library/contextlib.html#contextlib.contextmanager) або
* [`@contextlib.asynccontextmanager`](https://docs.python.org/3/library/contextlib.html#contextlib.asynccontextmanager)

буде придатною як залежність у **FastAPI**.

Насправді FastAPI використовує ці два декоратори внутрішньо.

///

    private final Pattern releaseNotesJavadocPattern = Pattern.compile("javadoc/(.*?\\.html)");
    // <a href="userguide/upgrading_version_8.html#changes_@baseVersion@">
    private final Pattern releaseNotesUserGuidePattern = Pattern.compile("userguide/(.*?)(?=\\.html)");

    @InputDirectory
    @PathSensitive(PathSensitivity.RELATIVE)
    public abstract DirectoryProperty getDocumentationRoot();

{* ../../docs_src/response_model/tutorial001_01_py310.py ln[15:17] hl[16] *}

## Réponse HTML { #html-response }

Pour renvoyer une réponse avec du HTML directement depuis **FastAPI**, utilisez `HTMLResponse`.

- Importez `HTMLResponse`.
- Passez `HTMLResponse` comme paramètre `response_class` de votre *décorateur de chemin d'accès*.

См. раздел `### Links` в общем промпте в `scripts/translate.py`.

////

## HTML-элементы "abbr" { #html-abbr-elements }

//// tab | Тест

Вот некоторые элементы, обёрнутые в HTML-элементы "abbr" (часть выдумана):

### abbr даёт полную расшифровку { #the-abbr-gives-a-full-phrase }

     */
    @Test
    public void testGetFromStream() throws Exception {
        final String path = ClassUtil.getPackageName(this.getClass()).replaceAll("\\.", "/") + "/aaa.html";
        final String contentType = MimeTypeUtil.guessContentType(path);
        assertEquals("text/html", contentType);
    }

    /**
     * @throws Exception
     */
    @Test
    public void testGetFromStream_gif() throws Exception {

結論として、最大のパフォーマンスを得たい場合は、[レスポンスモデル](../tutorial/response-model.md) を使い、*path operation デコレータ* で `response_class` は宣言しないでください。

{* ../../docs_src/response_model/tutorial001_01_py310.py ln[15:17] hl[16] *}

## HTMLレスポンス { #html-response }

**FastAPI** からHTMLを直接返すには、`HTMLResponse` を使います。

* `HTMLResponse` をインポートする
* *path operation デコレータ* のパラメータ `response_class` に `HTMLResponse` を渡す

{* ../../docs_src/custom_response/tutorial002_py310.py hl[2,7] *}

 Main component is <<<MavenRepositorySystemUtils>>>
 ({{{./apidocs/org/apache/maven/repository/internal/MavenRepositorySystemUtils.html}javadoc}},
 {{{./xref/org/apache/maven/repository/internal/MavenRepositorySystemUtils.html}source}}).

    //                                                                      ==============
    /**
     * Displays the role management index page.
     *
     * @param form the search form for filtering
     * @return HTML response for the role list page
     */
    @Execute
    @Secured({ ROLE, ROLE + VIEW })
    public HtmlResponse index(final SearchForm form) {
        return asListHtml();
    }

    /**

    //                                                                      ==============
    /**
     * Displays the request header management index page.
     *
     * @param form the search form for filtering
     * @return HTML response for the request header list page
     */
    @Execute
    @Secured({ ROLE, ROLE + VIEW })
    public HtmlResponse index(final SearchForm form) {
        return asListHtml();
    }

    /**