### ドキュメント UI の確認 { #check-the-docs-ui }

ここがポイントです。✨

「公式な」アクセス方法は、定義したパスプレフィックス付きのプロキシ経由です。したがって想定どおり、プレフィックスなしの URL で Uvicorn が直接提供するドキュメント UI にアクセスすると動作しません。プロキシ経由でアクセスされることを前提としているためです。

[http://127.0.0.1:8000/docs](http://127.0.0.1:8000/docs) を確認してください:

<img src="/img/tutorial/behind-a-proxy/image01.png">

しかし、プロキシ（ポート `9999`）を使った「公式」URL `/api/v1/docs` でドキュメント UI にアクセスすると、正しく動作します！🎉

 */

package jcifs.smb1.smb1;

/**
 * Interface defining DOS error codes and their mappings to NT status codes for SMB1 protocol.
 * Provides lookup tables for converting between DOS and NT error representations.
 */
public interface DosError {

    /**
     * Mapping table from DOS error codes to NT status codes.
     * Each entry contains a pair of [DOS error code, NT status code].
     */
    int[][] DOS_ERROR_CODES =

        val runningDocsTestTask: Property<Boolean>
    }

    override fun obtain(): String? = parameters.run {
        if (enableConfigurationCacheForDocsTests.getOrElse(false)) {
            // If the CC is enabled for docs tests, use a static dummy timestamp (the Epoch) so that we get hits,
            // otherwise we'll use the current timestamp by default and miss
            val formatter = SimpleDateFormat("yyyyMMddHHmmssZ").apply {

**FastAPI** **извлечёт** данные для **каждого поля** из **заголовков** запроса и выдаст заданную вами Pydantic-модель.

## Проверьте документацию { #check-the-docs }

Вы можете посмотреть нужные header-параметры в графическом интерфейсе сгенерированной документации по пути `/docs`:

<div class="screenshot">
<img src="/img/tutorial/header-param-models/image01.png">
</div>

Si quieres leer más sobre estas codificaciones y campos de formulario, dirígete a las [<abbr title="Mozilla Developer Network - Red de Desarrolladores de Mozilla">MDN</abbr> web docs para `POST`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST).

///

/// warning | Advertencia

# 條件式 OpenAPI { #conditional-openapi }

如果需要，你可以用設定與環境變數，依據執行環境有條件地調整 OpenAPI，甚至完全停用它。

## 關於安全性、API 與文件 { #about-security-apis-and-docs }

在正式環境中隱藏文件 UI *不應該* 是用來保護 API 的方式。

這並不會為你的 API 增添任何額外的安全性，*路徑操作* 仍舊照常可用。

若你的程式碼有安全性缺陷，它依然會存在。

隱藏文件只會讓他人更難理解如何與你的 API 互動，也可能讓你在正式環境除錯更困難。這通常僅被視為一種 [以隱匿求安全](https://en.wikipedia.org/wiki/Security_through_obscurity)。

如果你想保護 API，有許多更好的作法，例如：

- 確保針對請求本文與回應，具備定義良好的 Pydantic 模型。
- 透過依賴設定所需的權限與角色。

既定では次の設定が含まれます:

{* ../../fastapi/openapi/docs.py ln[9:24] hl[18:24] *}

引数 `swagger_ui_parameters` に別の値を指定することで、これらを上書きできます。

例えば、`deepLinking` を無効化するには、次の設定を `swagger_ui_parameters` に渡します:

{* ../../docs_src/configure_swagger_ui/tutorial003_py310.py hl[3] *}

## その他の Swagger UI パラメータ { #other-swagger-ui-parameters }

here. Ref: https://github.com/minio/minio/tree/master/docs/tls/kubernetes#2-create-kubernetes-secret certSecret: "" publicCrt: public.crt privateKey: private.key ## Trusted Certificates Settings for MinIO. Ref: https://docs.minio.io/docs/how-to-secure-access-to-minio-server-with-tls#install-certificates-from-third-party-cas ## Bundle multiple trusted certificates into one secret and pass that here. Ref: https://github.com/minio/minio/tree/master/docs/tls/kubernetes#2-create-kubernetes-secret ## When...

here. Ref: https://github.com/minio/minio/tree/master/docs/tls/kubernetes#2-create-kubernetes-secret certSecret: "" publicCrt: public.crt privateKey: private.key ## Trusted Certificates Settings for MinIO. Ref: https://docs.minio.io/docs/how-to-secure-access-to-minio-server-with-tls#install-certificates-from-third-party-cas ## Bundle multiple trusted certificates into one secret and pass that here. Ref: https://github.com/minio/minio/tree/master/docs/tls/kubernetes#2-create-kubernetes-secret ## When...

Isso é incrivelmente útil ao desenvolver e depurar código que interage com sua API.
///

## Documentação { #documentation }

E quando você abrir seu navegador em [http://127.0.0.1:8000/docs](http://127.0.0.1:8000/docs), você verá documentação automática, interativa, da API como:

<img src="/img/tutorial/path-params/image01.png">

/// check | Verifique