Commandes personnalisées pour webhook-audience-test
Aperçu
Le CLI webhook-audience-test supporte les commandes personnalisées écrites par l'utilisateur qui sont compilées dans le binaire aux côtés des commandes API auto-générées.
Les commandes personnalisées reçoivent un client SDK entièrement câblé qui hérite de l'authentification, des retries, du TLS, de l'URL de base et des en-têtes globaux du CLI — aucune configuration requise.
Architecture
cli/webhook-audience-test/custom.rs ← Vos handlers de commande (protégés par .fernignore)
cli/webhook-audience-test/sdk.rs ← Pont généré : client() + block_on()
cli/webhook-audience-test/main.rs ← Point d'entrée généré (appelle custom::register)
webhook-audience-test-sdk/ ← Crate SDK typé co-généré
webhook-audience-test-types/ ← Crate de modèles typés co-généré
Ajouter une commande personnalisée
1. Éditer cli/webhook-audience-test/custom.rs
Ce fichier est protégé par .fernignore — fern generate ne le
remplacera jamais. Enregistrez les commandes dans la fonction register() :
use webhook_audience_test_sdk::api::*;
pub fn register(app: CliApp) -> CliApp {
let app = app.command(
clap::Command::new("my-command")
.about("Description of your command")
.arg(clap::Arg::new("id").required(true)),
|matches, ctx| {
let id = matches.get_one::<String>("id").unwrap();
let client = super::sdk::client(ctx);
let result = super::sdk::block_on(
client.resource.get(id),
)?;
println!("{}", serde_json::to_string_pretty(&result).unwrap());
Ok(())
},
);
app
}
2. Clients SDK disponibles
L'appel super::sdk::client(ctx) retourne un webhook_audience_test_sdk::api::Client
avec les sous-clients suivants :
(Les sous-clients sont dérivés de la spécification API au moment de la génération.)
3. Motifs clés
Obtenir le client SDK (partage d'exécution, entièrement authentifié) :
let client = super::sdk::client(ctx);
Exécuter un appel SDK async depuis un handler sync :
let result = super::sdk::block_on(
client.some_resource.some_method(args),
)?;
Utiliser les modèles typés pour la sérialisation requête/réponse :
use webhook_audience_test_sdk::api::*;
Sécurité de régénération
| Fichier | Régénéré ? | Notes |
|---|---|---|
cli/webhook-audience-test/custom.rs |
Non | Protégé par .fernignore |
cli/webhook-audience-test/sdk.rs |
Oui | Pont AppContext → client SDK |
cli/webhook-audience-test/main.rs |
Oui | Appelle custom::register(app) |
webhook-audience-test-sdk/ |
Oui | Crate SDK typé co-généré |
webhook-audience-test-types/ |
Oui | Modèles typés co-générés |
Après avoir exécuté fern generate, votre custom.rs est préservé. Tout
le code généré (SDK, types, glue, main.rs) est mis à jour pour correspondre à
la dernière spécification API. Si la surface du SDK change (méthodes renommées, nouveaux
sous-clients), mettez à jour votre custom.rs en conséquence.
Build & Test
# Build le CLI (inclut les commandes personnalisées)
cargo build
# Exécuter votre commande personnalisée
webhook-audience-test <your-command> [args]
# Exécuter avec sortie verbose pour déboguer
RUST_LOG=debug webhook-audience-test <your-command> [args]