Commandes personnalisées pour server-url-templating-api

Vue d'ensemble

Le CLI server-url-templating-api prend en charge 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 disposent d'un client SDK complètement intégré qui hérite de l'authentification du CLI, des tentatives, du TLS, de l'URL de base et des en-têtes globaux — aucune configuration requise.

Architecture

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

Ajouter une commande personnalisée

1. Modifiez cli/server-url-templating-api/custom.rs

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

use server_url_templating_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 server_url_templating_api_sdk::api::Client avec les sous-clients suivants :

(Les sous-clients sont dérivés de la spécification de l'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 asynchrone à partir d'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 des requêtes/réponses :

use server_url_templating_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 de l'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
server-url-templating-api <your-command> [args]

# Exécuter avec affichage détaillé pour le débogage
RUST_LOG=debug server-url-templating-api <your-command> [args]