# 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

#

# Mac version of Core utilities differ in usage. Since our scripts are written
# with the GNU style, we need to set GNU utilities to be default on Mac.
if [[ -n "$(which grealpath)" ]] &&  [[ -n "$(which gstat)" ]]; then
  alias realpath=grealpath
  alias stat=gstat
  # By default, aliases are only expanded in interactive shells, which means
  # that they are not substituted for their corresponding commands in shell

    return false;
  });

  if (typeof $.fn.suggestor === "function") {
    $("#query").suggestor({
      ajaxinfo: {
        url: contextPath + "/api/v1/suggest-words",
        fn: ["_default", "content", "title"],
        num: 10,
        lang: $("#langSearchOption").val()
      },
      boxCssInfo: {
        border: "1px solid rgba(82, 168, 236, 0.5)",
        "-webkit-box-shadow":

    }, 3000);
    return true;
  });

  if (typeof $.fn.suggestor === "function") {
    $("#as_q").suggestor({
      ajaxinfo: {
        url: contextPath + "/api/v1/suggest-words",
        fn: ["_default", "content", "title"],
        num: 10,
        lang: $("#langSearchOption").val()
      },
      boxCssInfo: {
        border: "1px solid rgba(82, 168, 236, 0.5)",
        "-webkit-box-shadow":

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 }

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...

client_id     (string)    unique public identifier for apps e.g. "292085223830.apps.googleusercontent.com"
claim_name    (string)    JWT canned policy claim name, defaults to "policy"
claim_prefix  (string)    JWT claim namespace prefix e.g. "customer1/"
scopes        (csv)       Comma separated list of OpenID scopes for server, defaults to advertised scopes from discovery document e.g. "email,admin"
comment       (sentence)  optionally add a comment to this setting
```

 * 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

     * 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 */