Biblioteca di suggerimenti

Modifica online

La libreria dei prompt di API Agent fornisce una guida completa all'uso dei prompt per completare varie attività.

Linee guida per l'utilizzo dei suggerimenti

Per ottenere risultati accurati ed efficienti, segui queste linee guida quando inserisci i prompt:

Evita parole o toni che trasmettono sarcasmo o umorismo, poiché potrebbero essere fraintesi.
Usate la voce attiva, la grammatica e l'ortografia corrette e mantenete la richiesta chiara e specifica.
Fornite un contesto chiaro e parole chiave pertinenti, evitando termini vaghi o specifici del dominio. Ad esempio, generare API di test o di compilazione.
Se il sistema non è in grado di comprendere la tua richiesta, ti propone suggerimenti per richieste alternative.

Prerequisiti

Prima di utilizzare API Agent i prompt, assicurarsi che:

Accedi a API Agent. Per le istruzioni relative all'accesso e al funzionamento, consultare la sezione "Introduzione".
È necessario disporre delle autorizzazioni valide per poter utilizzare API Agent. Per ulteriori informazioni, consulta Ruoli utente dell'agente API.
Assicurati di disporre delle stesse autorizzazioni tramite API Connectl'interfaccia API Manager. Le azioni non vanno a buon fine se le autorizzazioni non corrispondono.

Utilizzo dei prompt per i diversi casi

La tabella seguente spiega i prompt e il loro utilizzo per le diverse azioni.

Tabella 1. Indicazioni per diversi casi
Suggerimenti per diversi casi
Azione	Richiesta	Descrizione
Generazione di casi di test	Generare casi di test per l'API `Generate test cases for <pulbished api name>`	Verificare che l'API sia pubblicata prima di generare casi di test per essa. Per ulteriori informazioni, consulta la guida "Creazione e pubblicazione di bozze API ". API Agent si collega alla funzione di generazione intelligente del modulo di test, che crea casi di test in modo iterativo per i primi 15 endpoint del file API disponibile. I casi di test sono memorizzati in una suite di test che ha come suffisso`AA_Test_Suite` insieme a `api name (AA_Test_Suite_<api_name>)`. Al termine della generazione, API Agent visualizza il messaggio di stato che indica il numero di casi di test creati e il nome della suite di test in cui sono stati creati. È possibile trovare i casi di test generati nel modulo Test della console API Manager.
Esecuzione dei casi di test	Eseguire casi di test per l'API `Run test cases for <pulbished api name>` Nota: `<published api name>` deve contenere il nome dell'API. Non combinare le informazioni sulla versione. Ad esempio, `petstore`.	È possibile eseguire i casi di test per un'API pubblicata in Visual Studio Code, tra cui l'avvio del test, la visualizzazione dei risultati e l'eventuale eliminazione di un caso di test. La funzione Smart Generation del moduloAPI Agent di test genera i dati per i parametri di input necessari per eseguire il test. Il sito API Agent visualizza il messaggio di stato e gli URL dei risultati dei test in Visual Studio Code dopo che le esecuzioni sono state avviate con successo.
Eliminazione dei casi di test	`delete test case <test_name> in suite <suite_name>`	Clicca sul collegamento ipertestuale per visualizzare i risultati dei singoli casi di test nella console API Manager.
Elencare le suite di test	`List test suites`	Si può usare per elencare gli abiti di prova. Inoltre, è possibile eliminare una suite di test inserendo un prompt con il nome della suite.
Eliminazione della suite di test	`delete test suite <suite_name>`
Elenco dei casi di test	`List test cases for test suite <test suite name>`	Si può usare per elencare i casi di test corrispondenti a una suite di test. Assicurarsi che le suite di test siano disponibili. Se non disponibile, seguire i passaggi indicati nella riga Generazione dei casi di test. Per identificare le suite di test disponibili, consultare la riga Elenco suite di test.
Creare un OpenAPI	Per creare una specifica API per la tabella ordini `create openapi for orders table` oppure `generate api spec for orders table` Nota: il database non deve contenere un'altra tabella con lo stesso nome in un altro schema, poiché questa situazione potrebbe causare confusione. Per creare una specifica API per la tabella ordini `create openapi for orders table with schema_name as purchase_order` Oppure `create openapi for orders table in purchase_order schema` Per creare una specifica API per la tabella degli ordini utilizzando il nome dell'oggetto e senza il nome dello schema `create openapi for orders table with object_name as purchase_order_orders` Per creare una specifica API per la tabella ordini utilizzando l'ID sorgente `create openapi for orders table with source_id as 6c115670-a7e1-11ef-b576-fa5e88d5392d` Per estrarre la specifica OpenAPI per il nome della tabella e le trasformazioni in formato specifico per il generatore di codice `Extract the openapi spec for the given table name and transforms to Code generator specific format`	Di seguito sono riportati alcuni esempi di prompt che è possibile utilizzare per creare un'API aperta.
Generazione codice	Per generare il codice di un semplice tipo di server `Generate some Python FastAPI server code based on the following openapi @my_file.yaml` Oppure `Please build FastAPI backend code using the OpenAPI file @api_spec.yaml` Oppure `Can you develop a Python FastAPI server using the openapi specification provided in @service_definition.json` Per generare il codice per la creazione, il recupero, l'aggiornamento e la cancellazione di un database di tipo server `Generate some Python FastAPI server code based on the following openapi @my_file.yaml that handles database operations` Oppure `Can you develop a database driven Python FastAPI server using the openapi specification provided in @service_definition.json` Nota: vedi Nota: per ulteriori informazioni sull'uso dei prompt tramite lo strumento OpenAPI Python Generator, consultare lo strumento OpenAPI Python Generator.	Genera FastAPI codice server basato sulle OpenAPI specifiche.
Azioni del server MCP	Per visualizzare l'elenco dei server abilitati `List me all the MCP servers that are currently enabled` Oppure `List all available MCP servers` Per ottenere i dettagli del server MCP `Fetch the details of GitHub™ MCP server` Per aggiornare il server MCP `Update the enabled MCP server gitlab™ with updated deployed url [Add URL]` Per disabilitare il server MCP da GitHub `Remove the github™ MCP server from the enabled tools` Per ottenere informazioni dettagliate su uno specifico server MCP `Fetch details of the mcp server postman™` oppure `Show me the configuration details for the github™ MCP server` Oppure `Get information about the weather MCP server` Per verificare se un server MCP esiste o meno `Check the existence of mcp server Github™` Oppure `check availability of mcp server postman™` Oppure `check if postman™ mcp server is available`	Utilizzare i seguenti prompt per eseguire le seguenti operazioni con il server MCP: Elenco dei server abilitati Dettagli server Aggiorna Disabilita Dettagli su un server MCP specifico Verificare l'esistenza del server MCP

Richiami sequenziali

Utilizza API Agent per concatenare più strumenti in un unico prompt ed eseguirli uno dopo l'altro. Di seguito sono riportati alcuni esempi di prompt sequenziali:

Creare ed eseguire casi di test

create test cases for the petstore api and run the test cases

Elenco delle API o dei prodotti in fase di bozza o già pubblicati

list draft apis, draft products, published apis and published products

Oppure

list published apis

Creare una bozza di API e generare il codice FastAPI server

create draft api from file @openapi.yaml and generate fastapi server code from the same api file

Oppure

create draft api using @file_name

Verifica della sicurezza di un'API

review security of api API_NAME:VERSION

Oppure

validate api API_NAME:VERSION