Sebastián Ramírez <******@****.***> 1766004103 -0800

import importlib
from types import ModuleType

import pytest
from fastapi.testclient import TestClient


@pytest.fixture(
    name="mod",
    params=[
        pytest.param("tutorial008d_py39"),
        pytest.param("tutorial008d_an_py39"),
    ],
)
def get_mod(request: pytest.FixtureRequest):
    mod = importlib.import_module(f"docs_src.dependencies.{request.param}")

    return mod

[tool.ruff.lint.per-file-ignores]
"__init__.py" = ["F401"]
"docs_src/dependencies/tutorial007_py39.py" = ["F821"]
"docs_src/dependencies/tutorial008_py39.py" = ["F821"]
"docs_src/dependencies/tutorial009_py39.py" = ["F821"]
"docs_src/dependencies/tutorial010_py39.py" = ["F821"]
"docs_src/custom_response/tutorial007_py39.py" = ["B007"]
"docs_src/dataclasses/tutorial003_py39.py" = ["I001"]

Você pode defini-los da seguinte maneira:

{* ../../docs_src/metadata/tutorial001_py39.py hl[3:16, 19:32] *}

/// tip | Dica

Você pode escrever Markdown no campo `description` e ele será renderizado na saída.

///

Com essa configuração, a documentação automática da API se pareceria com:

import importlib

import pytest
from fastapi.testclient import TestClient


@pytest.fixture(
    name="mod_name",
    params=[
        pytest.param("tutorial002_py39"),
        pytest.param("tutorial003_py39"),
        pytest.param("tutorial004_py39"),
    ],
)
def get_mod_name(request: pytest.FixtureRequest) -> str:
    return request.param


@pytest.fixture(name="client")
def get_client(mod_name: str) -> TestClient:

<img src="/img/tutorial/extending-openapi/image02.png">

Но вы можете отключить её, установив `syntaxHighlight` в `False`:

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

…и после этого Swagger UI больше не будет показывать подсветку синтаксиса:

<img src="/img/tutorial/extending-openapi/image03.png">

## Изменить тему { #change-the-theme }

<img src="/img/tutorial/extending-openapi/image02.png">

But you can disable it by setting `syntaxHighlight` to `False`:

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

...and then Swagger UI won't show the syntax highlighting anymore:

<img src="/img/tutorial/extending-openapi/image03.png">

## Change the Theme { #change-the-theme }

Tienes que asegurarte de que sea único para cada operación.

{* ../../docs_src/path_operation_advanced_configuration/tutorial001_py39.py hl[6] *}

### Usar el nombre de la *path operation function* como el operationId { #using-the-path-operation-function-name-as-the-operationid }

Você precisa ter certeza que ele é único para cada operação.

{* ../../docs_src/path_operation_advanced_configuration/tutorial001_py39.py hl[6] *}

### Utilizando o nome da *função de operação de rota* como o operationId { #using-the-path-operation-function-name-as-the-operationid }

<img src="/img/tutorial/extending-openapi/image02.png">

Pero puedes desactivarlo estableciendo `syntaxHighlight` en `False`:

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

...y entonces Swagger UI ya no mostrará el resaltado de sintaxis:

<img src="/img/tutorial/extending-openapi/image03.png">

## Cambiar el tema { #change-the-theme }