Commandes personnalisées pour query-param-name-conflict-api

Vue d'ensemble

Le CLI query-param-name-conflict-api supporte les commandes personnalisées rédigées 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 complètement câblé qui hérite de l'authentification, des tentatives, du TLS, de l'URL de base et des en-têtes globaux du CLI — zéro configuration requise.

Architecture

cli/query-param-name-conflict-api/custom.rs    ← Vos gestionnaires de commandes (protégés par .fernignore)
cli/query-param-name-conflict-api/sdk.rs       ← Pont généré : client() + block_on()
cli/query-param-name-conflict-api/main.rs      ← Point d'entrée généré (appelle custom::register)
query-param-name-conflict-api-sdk/             ← Crate SDK typé co-généré
query-param-name-conflict-api-types/           ← Crate modèles typés co-généré

Ajouter une commande personnalisée

1. Éditer cli/query-param-name-conflict-api/custom.rs

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

use query_param_name_conflict_api_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 query_param_name_conflict_api_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, complètement authentifié) :

let client = super::sdk::client(ctx);

Exécuter un appel SDK asynchrone à partir d'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 des requêtes/réponses :

use query_param_name_conflict_api_sdk::api::*;

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

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 spécification API. Si la surface du SDK change (méthodes renommées, nouveaux sous-clients), mettez à jour votre custom.rs en conséquence.

Construire et tester

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

# Exécuter votre commande personnalisée
query-param-name-conflict-api <your-command> [args]

# Exécuter avec sortie détaillée pour le débogage
RUST_LOG=debug query-param-name-conflict-api <your-command> [args]