Commandes personnalisées pour url-form-encoded-api

Vue d'ensemble

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

Ajouter une commande personnalisée

1. Éditer cli/url-form-encoded-api/custom.rs

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

use url_form_encoded_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 url_form_encoded_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. Modèles 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 gestionnaire sync :

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 url_form_encoded_api_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.

Build et test

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

# Exécuter votre commande personnalisée
url-form-encoded-api <your-command> [args]

# Exécuter avec sortie détaillée pour le débogage
RUST_LOG=debug url-form-encoded-api <your-command> [args]