Commandes personnalisées pour no-content-response
Aperçu
Le CLI no-content-response supporte les commandes personnalisées écrites par l'utilisateur, 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 configuré qui hérite de l'authentification, des retries, du TLS, de l'URL de base et des en-têtes globaux du CLI — zéro configuration requise.
Architecture
cli/no-content-response/custom.rs ← Vos gestionnaires de commande (protégé par .fernignore)
cli/no-content-response/sdk.rs ← Pont généré : client() + block_on()
cli/no-content-response/main.rs ← Point d'entrée généré (appelle custom::register)
no-content-response-sdk/ ← Crate SDK typé co-généré
no-content-response-types/ ← Crate modèle typé co-généré
Ajouter une commande personnalisée
1. Éditer cli/no-content-response/custom.rs
Ce fichier est protégé par .fernignore — fern generate ne l'écrasera jamais.
Enregistrez les commandes dans la fonction register() :
use no_content_response_sdk::api::*;
pub fn register(app: CliApp) -> CliApp {
let app = app.command(
clap::Command::new("get")
.about("Get Contact")
.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.contacts.get(id),
)?;
println!("{}", serde_json::to_string_pretty(&result).unwrap());
Ok(())
},
);
app
}
Ensuite compilez et testez :
cargo build
no-content-response get <id>
2. Clients SDK disponibles
L'appel super::sdk::client(ctx) retourne un no_content_response_sdk::api::Client
avec les sous-clients suivants :
| Champ | Type | Description |
|---|---|---|
client.contacts |
no_content_response_sdk::api::ContactsClient |
opérations contacts |
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 asynchrone depuis un gestionnaire synchrone :
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 no_content_response_sdk::api::*;
Sécurité de régénération
| Fichier | Régénéré ? | Notes |
|---|---|---|
cli/no-content-response/custom.rs |
Non | Protégé par .fernignore |
cli/no-content-response/sdk.rs |
Oui | Pont AppContext → client SDK |
cli/no-content-response/main.rs |
Oui | Appelle custom::register(app) |
no-content-response-sdk/ |
Oui | Crate SDK typé co-généré |
no-content-response-types/ |
Oui | Modèles typés co-générés |
Après avoir exécuté fern generate, votre custom.rs est conservé. Tout le code généré (SDK, types, glue, main.rs) est mis à jour pour correspondre à la dernière spec API. Si la surface du SDK change (méthodes renommées, nouveaux sous-clients), mettez à jour votre custom.rs en conséquence.
Compiler et tester
# Compiler le CLI (inclut les commandes personnalisées)
cargo build
# Exécuter votre commande personnalisée
no-content-response <your-command> [args]
# Exécuter avec une sortie verbale pour déboguer
RUST_LOG=debug no-content-response <your-command> [args]