Páginas de endpoints
As páginas de operações da API são renderizadas a partir da fonte OpenAPI ou Swagger correspondente. Cada página de operação contém apenas frontmatter: uma chave
openapi que aponta para a especificação renderizada, além das chaves opcionais title e description que substituem os valores renderizados:
/en/ ou /es/ correspondente na página traduzida. O método e o caminho permanecem idênticos em todos os idiomas.
O Mintlify renderiza os detalhes da operação a partir da especificação. Não duplique manualmente parâmetros, exemplos de requisição e resposta, corpos de erro ou descrições de endpoints em uma página de operação.
Atualizando uma operação
Atualize primeiro o contrato canônico da API do serviço. Em seguida, sincronize as especificações renderizadas e mantenha os stubs das operações alinhados ao método e ao caminho resultantes. Isso mantém a referência precisa em todos os idiomas compatíveis.
Antes de publicar
- Verifique se a especificação renderizada contém a operação.
- Use o mesmo método e caminho em cada idioma.
- Mantenha descrições de comportamento, schemas e exemplos no contrato do serviço, não em uma página de operação escrita manualmente.