Commandes personnalisées pour api

Vue d'ensemble

Le CLI api 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, de TLS, de l'URL de base et des en-têtes globaux du CLI — zéro configuration requise.

Architecture

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

Ajouter une commande personnalisée

1. Éditer cli/api/custom.rs

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

use api_sdk::api::*;

pub fn register(app: CliApp) -> CliApp {
    let app = app.command(
        clap::Command::new("upload-file")
            .about("Upload a file to the database")
        ,
        |matches, ctx| {
            let client = super::sdk::client(ctx);
            let result = super::sdk::block_on(
                client.file_upload_example.upload_file(),
            )?;
            println!("{}", serde_json::to_string_pretty(&result).unwrap());
            Ok(())
        },
    );
    app
}

Puis compilez et testez :

cargo build
api upload-file

2. Clients SDK disponibles

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

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

Build & Test

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

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

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