Skip to content

Commit 97ac228

Browse files
marcelomarkusmarcelomarkus
authored
🌐 Add Portuguese translation for docs/pt/docs/how-to/configure-swagger-ui.md (fastapi#12222)
1 parent 7c6f2f8 commit 97ac228

File tree

1 file changed

+78
-0
lines changed

1 file changed

+78
-0
lines changed

‎docs/pt/docs/how-to/configure-swagger-ui.md‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# Configurar Swagger UI
2+
3+
Você pode configurar alguns <a href="https://swagger.io/docs/open-source-tools/swagger-ui/usage/configuration" class="external-link" target="_blank">parâmetros extras da UI do Swagger</a>.
4+
5+
Para configurá-los, passe o argumento `swagger_ui_parameters` ao criar o objeto de aplicativo `FastAPI()` ou para a função `get_swagger_ui_html()`.
6+
7+
`swagger_ui_parameters` recebe um dicionário com as configurações passadas diretamente para o Swagger UI.
8+
9+
O FastAPI converte as configurações para **JSON** para torná-las compatíveis com JavaScript, pois é disso que o Swagger UI precisa.
10+
11+
## Desabilitar realce de sintaxe
12+
13+
Por exemplo, você pode desabilitar o destaque de sintaxe na UI do Swagger.
14+
15+
Sem alterar as configurações, o destaque de sintaxe é habilitado por padrão:
16+
17+
<img src="/img/tutorial/extending-openapi/image02.png">
18+
19+
Mas você pode desabilitá-lo definindo `syntaxHighlight` como `False`:
20+
21+
```Python hl_lines="3"
22+
{!../../../docs_src/configure_swagger_ui/tutorial001.py!}
23+
```
24+
25+
...e então o Swagger UI não mostrará mais o destaque de sintaxe:
26+
27+
<img src="/img/tutorial/extending-openapi/image03.png">
28+
29+
## Alterar o tema
30+
31+
Da mesma forma que você pode definir o tema de destaque de sintaxe com a chave `"syntaxHighlight.theme"` (observe que há um ponto no meio):
32+
33+
```Python hl_lines="3"
34+
{!../../../docs_src/configure_swagger_ui/tutorial002.py!}
35+
```
36+
37+
Essa configuração alteraria o tema de cores de destaque de sintaxe:
38+
39+
<img src="/img/tutorial/extending-openapi/image04.png">
40+
41+
## Alterar parâmetros de UI padrão do Swagger
42+
43+
O FastAPI inclui alguns parâmetros de configuração padrão apropriados para a maioria dos casos de uso.
44+
45+
Inclui estas configurações padrão:
46+
47+
```Python
48+
{!../../../fastapi/openapi/docs.py[ln:7-23]!}
49+
```
50+
51+
Você pode substituir qualquer um deles definindo um valor diferente no argumento `swagger_ui_parameters`.
52+
53+
Por exemplo, para desabilitar `deepLinking` você pode passar essas configurações para `swagger_ui_parameters`:
54+
55+
```Python hl_lines="3"
56+
{!../../../docs_src/configure_swagger_ui/tutorial003.py!}
57+
```
58+
59+
## Outros parâmetros da UI do Swagger
60+
61+
Para ver todas as outras configurações possíveis que você pode usar, leia a <a href="https://swagger.io/docs/open-source-tools/swagger-ui/usage/configuration" class="external-link" target="_blank">documentação oficial dos parâmetros da UI do Swagger</a>.
62+
63+
## Configurações somente JavaScript
64+
65+
A interface do usuário do Swagger também permite que outras configurações sejam objetos **somente JavaScript** (por exemplo, funções JavaScript).
66+
67+
O FastAPI também inclui estas configurações de `predefinições` somente para JavaScript:
68+
69+
```JavaScript
70+
presets: [
71+
SwaggerUIBundle.presets.apis,
72+
SwaggerUIBundle.SwaggerUIStandalonePreset
73+
]
74+
```
75+
76+
Esses são objetos **JavaScript**, não strings, então você não pode passá-los diretamente do código Python.
77+
78+
Se você precisar usar configurações somente JavaScript como essas, você pode usar um dos métodos acima. Sobrescreva todas as *operações de rotas* do Swagger UI e escreva manualmente qualquer JavaScript que você precisar.

0 commit comments

Comments
 (0)