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

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

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

E será documentado como tal no OpenAPI.

///

/// tip | Dica

A `ORJSONResponse` está disponível apenas no FastAPI, e não no Starlette.

///

## Resposta HTML { #html-response }

Para retornar uma resposta com HTML diretamente do **FastAPI**, utilize `HTMLResponse`.

* Importe `HTMLResponse`
* Passe `HTMLResponse` como o parâmetro de `response_class` do seu *decorador de operação de rota*.

    //                                                                      ==============
    /**
     * Displays the user management index page.
     *
     * @return HTML response for the user list page
     */
    @Execute
    @Secured({ ROLE, ROLE + VIEW })
    public HtmlResponse index() {
        return asListHtml();
    }

    /**

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

    /**

Ahora puedes crear las *path operations* para la documentación personalizada.

Puedes reutilizar las funciones internas de FastAPI para crear las páginas HTML para la documentación, y pasarles los argumentos necesarios:

* `openapi_url`: la URL donde la página HTML para la documentación puede obtener el OpenAPI esquema de tu API. Puedes usar aquí el atributo `app.openapi_url`.
* `title`: el título de tu API.

Agora você pode criar as *operações de rota* para a documentação personalizada.

Você pode reutilizar as funções internas do FastAPI para criar as páginas HTML para a documentação e passar os argumentos necessários:

* `openapi_url`: a URL onde a página HTML para a documentação pode obter o esquema OpenAPI para a sua API. Você pode usar aqui o atributo `app.openapi_url`.
* `title`: o título da sua API.

    }

    /**
     * Gets the pattern used for matching HTML tags.
     *
     * @return the HTML tag pattern
     */
    public Pattern getHtmlTagPattern() {
        return htmlTagPattern;
    }

    /**
     * Sets the pattern used for matching HTML tags.
     *
     * @param htmlTagPattern the HTML tag pattern to set
     */

    init {
        features {
            buildReportTab("Problems Report", "problems-report.html")
            if (stage.specificBuilds.contains(SpecificBuild.SanityCheck)) {
                buildReportTab(
                    "API Compatibility Report",
                    "$HIDDEN_ARTIFACT_DESTINATION/report-architecture-test-binary-compatibility-report.html",
                )

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

* You can get metadata from the uploaded file.
* It has a <a href="https://docs.python.org/3/glossary.html#term-file-like-object" class="external-link" target="_blank">file-like</a> `async` interface.