# OpenAPI `docs`

Utilities to handle OpenAPI automatic UI documentation, including Swagger UI (by default at `/docs`) and ReDoc (by default at `/redoc`).

::: fastapi.openapi.docs.get_swagger_ui_html

::: fastapi.openapi.docs.get_redoc_html

::: fastapi.openapi.docs.get_swagger_ui_oauth2_redirect_html

This could be useful if for example you live in a country that restricts some URLs.

### Disable the automatic docs { #disable-the-automatic-docs }

The first step is to disable the automatic docs, as by default, those use the default CDN.

To disable them, set their URLs to `None` when creating your `FastAPI` app:

{* ../../docs_src/custom_docs_ui/tutorial001.py hl[8] *}

### Include the custom docs { #include-the-custom-docs }

 * This class provides functionality to handle virtual host-based routing
 * and path resolution based on HTTP headers.
 */
public class VirtualHostHelper {

    /**
     * Default constructor.
     */
    public VirtualHostHelper() {
        // Default constructor
    }

    /**
     * Gets the virtual host path for the specified HTML page.
     *
     * @param page The HTML page to get the virtual host path for

globalThis?globalThis:t||self).bootstrap=e(t.Popper)}(this,(function(t){"use strict";function e(t){const e=Object.create(null,{[Symbol.toStringTag]:{value:"Module"}});if(t)for(const s in t)if("default"!==s){const i=Object.getOwnPropertyDescriptor(t,s);Object.defineProperty(e,s,i.get?i:{enumerable:!0,get:()=>t[s]})}return e.default=t,Object.freeze(e)}const s=e(t),i=new Map,n={set(t,e,s){i.has(t)||i.set(t,new Map);const n=i.get(t);n.has(e)||0===n.size?n.set(e,s):console.error(`Bootstrap doesn't allow more than...

    /**
     * Default constructor for PurgeThumbnailJob.
     * Creates a new instance of the thumbnail purging job with default expiry time (30 days).
     */
    public PurgeThumbnailJob() {
        // Default constructor
    }

    /** Expiration time for thumbnails in milliseconds (default: 30 days) */
    private long expiry = 30 * 24 * 60 * 60 * 1000L;

    /**

 *
 * <p><b>{@code default} method warning:</b> This class forwards calls to <i>only some</i> {@code
 * default} methods. Specifically, it forwards calls only for methods that existed <a
 * href="https://docs.oracle.com/javase/7/docs/api/java/util/concurrent/ConcurrentMap.html">before
 * {@code default} methods were introduced</a>. For newer methods, like {@code forEach}, it inherits

        <field>
          <name>defaultGoal</name>
          <version>3.0.0+</version>
          <description>The default goal to execute when none is specified for
            the project. Note that in case of a build with subprojects, only the default goal of the top-level
            project is relevant, i.e. the default goals of subprojects are ignored. Since Maven 3,
            multiple goals/phases can be separated by whitespace.</description>

     * Contains the relative ID and name of a SAM object.
     */
    public static class SamrSamEntry extends NdrObject {

        /**
         * Default constructor for SamrSamEntry.
         */
        public SamrSamEntry() {
            // Default constructor
        }

        /** The relative ID (RID) of the SAM entry */
        public int idx;
        /** The name of the SAM entry */

     * Contains the relative ID and name of a SAM object.
     */
    public static class SamrSamEntry extends NdrObject {

        /**
         * Default constructor for SamrSamEntry.
         */
        public SamrSamEntry() {
            // Default constructor
        }

        /** The relative ID (RID) of the SAM entry */
        public int idx;
        /** The name of the SAM entry */

    - Copy the OAuth Client Secret as the value for `<CLIENT_SECRET>`.
  - By default, `<IS_HOST>` is localhost. However, if using a public IP, the respective IP address or domain needs to be specified.
  - By default, `<IS_HTTPS_PORT>` has been set to 9443. However, if the port offset has been incremented by n, the default port value needs to be incremented by n.

Request

```