Commandes personnalisées pour api-wide-base-path-with-default

Vue d'ensemble

Le CLI api-wide-base-path-with-default 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 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/api-wide-base-path-with-default/custom.rs    ← Vos gestionnaires de commandes (protégés par .fernignore)
cli/api-wide-base-path-with-default/sdk.rs       ← Pont généré : client() + block_on()
cli/api-wide-base-path-with-default/main.rs      ← Point d'entrée généré (appelle custom::register)
api-wide-base-path-with-default-sdk/             ← Crate SDK typé co-généré
api-wide-base-path-with-default-types/           ← Crate de modèles typés co-généré

Ajouter une commande personnalisée

1. Éditer cli/api-wide-base-path-with-default/custom.rs

Ce fichier est protégé par .fernignore — fern generate ne le surécrit jamais. Enregistrez les commandes dans la fonction register() :

use api_wide_base_path_with_default_sdk::api::*;

pub fn register(app: CliApp) -> CliApp {
    let app = app.command(
        clap::Command::new("widgets-create")
            .about("Run widgets widgets-create")
            .arg(clap::Arg::new("apiVersion").required(true))
        ,
        |matches, ctx| {
            let api_version = matches.get_one::<String>("apiVersion").unwrap();
            let client = super::sdk::client(ctx);
            let result = super::sdk::block_on(
                client.widgets.widgets_create(api_version),
            )?;
            println!("{}", serde_json::to_string_pretty(&result).unwrap());
            Ok(())
        },
    );
    app
}

Puis compilez et testez :

cargo build
api-wide-base-path-with-default widgets-create <apiVersion>

2. Clients SDK disponibles

L'appel super::sdk::client(ctx) retourne un api_wide_base_path_with_default_sdk::api::Client avec les sous-clients suivants :

3. Patterns 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 des modèles typés pour la sérialisation requête/réponse :

use api_wide_base_path_with_default_sdk::api::*;

Sécurité de la régénération

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.

Compiler et tester

# Compiler le CLI (inclut les commandes personnalisées)
cargo build

# Exécuter votre commande personnalisée
api-wide-base-path-with-default <your-command> [args]

# Exécuter avec une sortie détaillée pour déboguer
RUST_LOG=debug api-wide-base-path-with-default <your-command> [args]