# gt: General Translation CLI tool: gt api URL: https://generaltranslation.com/it/docs/cli/reference/commands/api.mdx Docs index: https://generaltranslation.com/llms.txt Description: Esegui richieste non elaborate autenticate oppure consulta il contratto incluso della General Translation API. Riferimento API per il comando gt api. Usa `gt api` quando ti serve accedere direttamente a un endpoint senza aggiungere un client HTTP al tuo progetto. Il comando consente anche di elencare le operazioni API incluse o di stampare il contratto di una singola operazione senza caricare l'intera specifica OpenAPI. ## Panoramica [#overview] ```bash npx gt api [endpoint] [options] ``` Passa un percorso di endpoint come `/v2/project/info/PROJECT_ID` per effettuare una richiesta. Usa `--list` senza un endpoint per individuare le operazioni disponibili, oppure passa a `--spec` un ID di operazione, un percorso della specifica o un percorso di richiesta concreto per esaminare un contratto più circoscritto. ## Come funziona [#how-it-works] * Usa la chiave esplicita fornita tramite `--api-key` o `GT_API_KEY`; in caso contrario, usa il login salvato. (Vedi [precedenza dell'autenticazione](/docs/cli/guides/configuring#credentials)). * Determina l'ID progetto da `--project-id`, `gt.config.json` o `GT_PROJECT_ID`. * Invia la richiesta al `baseUrl` configurato, che per impostazione predefinita è `https://api.gtx.dev`. * Scrive il body non elaborato della risposta sullo standard output, senza ritentare la richiesta in caso di errori di rete o risposte HTTP 429/5xx. * Scrive un riepilogo sullo standard error ed esce con stato 1 in caso di risposta non 2xx. Se `gt.config.json` fornisce un ID progetto diverso da quello indicato in `--project-id` o nell'ambiente, il comando si interrompe prima di inviare la richiesta. Se invece gli ID differenti provengono solo dal flag e dall'ambiente, prevale il flag. `--list` stampa una riga separata da tabulazioni per ogni operazione inclusa: metodo, percorso, ID operazione e riepilogo. Se si specifica un endpoint, `--spec` cerca prima un ID operazione, poi un percorso esatto della specifica e infine un percorso di richiesta concreto, abbinandolo ai parametri di percorso. Risolve i riferimenti dello schema nell'output filtrato e conserva i componenti referenziati e gli schemi di sicurezza. I riferimenti ricorsivi dello schema rimangono come valori `$ref`. ## Flag [#flags] | Parametro | Descrizione | Tipo | Facoltativo | Predefinito | | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | --------- | ----------- | ------------------------------ | | `-X, --method ` | Metodo HTTP: `GET`, `HEAD`, `POST`, `PUT`, `PATCH`, `DELETE` oppure `OPTIONS`. | `string` | Sì | `GET` | | `--input ` | Legge il body della richiesta da un file, oppure dallo standard input se impostato su `-`. | `string` | Sì | — | | `-H, --header
` | Aggiunge un header di richiesta `Key: Value`. Ripeti il flag per più header. | `string` | Sì | — | | `-i, --include` | Scrive lo status e gli header della risposta prima del body. | `boolean` | Sì | `false` | | `--spec` | Stampa la specifica OpenAPI 3.1 inclusa nel bundle, filtrata sull'endpoint indicato, se presente. | `boolean` | Sì | `false` | | `--list` | Stampa tutte le operazioni API incluse nel bundle, con i campi metodo, percorso, ID operazione e riepilogo separati da tabulazioni. | `boolean` | Sì | `false` | | `-c, --config ` | Percorso di `gt.config.json`. Il suffisso `.json` può essere omesso. | `string` | Sì | Risolto automaticamente | | `--api-key ` | Override esplicito della chiave degli strumenti. | `string` | Sì | `GT_API_KEY`, altrimenti login | | `--project-id ` | Override dell'ID progetto. | `string` | Sì | Config oppure `GT_PROJECT_ID` | `--list` e `--spec` funzionano offline e non richiedono login, chiave API, ID progetto né impostazioni di traduzione valide. Non possono essere usati insieme. Se la ricerca mirata nella specifica non trova alcuna operazione corrispondente, il comando termina con codice di uscita 1 e suggerisce di usare `--list`. ## Esempi [#examples] ```bash # Salva lo snapshot dell'API incluso nelle dipendenze della CLI installata npx gt api --spec > openapi.json # Elenca le operazioni incluse npx gt api --list # Stampa una singola operazione tramite il suo ID o il percorso effettivo della richiesta npx gt api --spec getProjectInfo npx gt api --spec /v2/project/info/PROJECT_ID # Legge le informazioni del progetto usando il login salvato o una chiave specificata esplicitamente npx gt api /v2/project/info/PROJECT_ID # Invia un body della richiesta in JSON e include i metadati della risposta npx gt api /v2/project/info/PROJECT_ID \ --method POST \ --header "Content-Type: application/json" \ --input update.json \ --include # Legge un body dallo standard input printf '{"defaultLocale":"fr"}' | npx gt api /v2/project/info/PROJECT_ID \ --method POST \ --header "Content-Type: application/json" \ --input - ``` ## Altre note [#notes] * `--spec` stampa lo snapshot installato; non recupera la specifica attualmente ospitata. * Una ricerca per percorso stampa tutti i metodi presenti nel percorso corrispondente della specifica. Il flag `--method` non filtra l'output della specifica. * Il comando ignora la convalida delle impostazioni di file e delle impostazioni regionali della CLI, quindi eventuali impostazioni di traduzione non valide non bloccano una richiesta API non elaborata. * Consulta il [riferimento OpenAPI](/docs/platform/openapi/overview) per individuare i percorsi degli endpoint, le autorizzazioni, i field della richiesta e gli schemi delle risposte. ### Cronologia delle versioni | Versione | Modifiche | | -------- | -------------------------------------------------------------------------------- | | `2.25.0` | Aggiunti `--list` e l'output mirato con `--spec `. | | `2.20.0` | Aggiunto `gt api` con richieste non elaborate e output della specifica completa. | ## Sitemap See the full [sitemap](https://generaltranslation.com/sitemap.md) for all pages.