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 complètement câblé qui hérite de l'authentification du CLI, des tentatives, du TLS, de l'URL de base et des en-têtes globaux — 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ée co-générée
api-types/           ← Crate modèle typée co-générée

Ajouter une commande personnalisée

1. Éditer cli/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 api_sdk::api::*;

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

Puis compilez et testez :

cargo build
api get-movie <movieId>

2. Clients SDK disponibles

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

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 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 api_sdk::api::*;

4. Authentification

Les commandes personnalisées héritent automatiquement de l'authentification du CLI. Les schémas d'authentification suivants sont configurés :

• bearer (porteur) : env API_TOKEN

Aucun câblage d'authentification manuel n'est nécessaire dans les gestionnaires de commande personnalisée.

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

Après l'exécution de 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.

Compilation et 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 verbeux pour déboguer
RUST_LOG=debug api <your-command> [args]