github/typespec-create-api-plugin

Que fait typespec-create-api-plugin ?

Générer un plugin d'API TypeSpec avec des opérations REST, l'authentification et des cartes adaptatives pour Microsoft 365 Copilot

Aperçu

Ce plugin permet aux développeurs de créer rapidement un plugin d'API TypeSpec prêt à être utilisé comme source de données pour Microsoft 365 Copilot. Il génère automatiquement les fichiers TypeSpec nécessaires, y compris les définitions d'opérations REST, la configuration d'authentification et les cartes adaptatives pour afficher les résultats dans Copilot.

Fonctionnalités

• Génération de fichiers TypeSpec avec des décorations pour décrire les endpoints REST
• Configuration d'authentification OAuth2 / API Key
• Création de cartes adaptatives pour personnaliser la présentation des résultats
• Prise en charge des opérations CRUD de base
• Intégration avec les outils de développement TypeSpec

Utilisation

Pour utiliser ce plugin, vous devez avoir TypeSpec installé sur votre machine. Exécutez la commande suivante pour générer un nouveau plugin d'API :

typespec init --template github/typespec-create-api-plugin

Cela créera un nouveau répertoire avec les fichiers TypeSpec générés. Vous pouvez ensuite personnaliser les fichiers selon vos besoins.

Structure des fichiers générés

Le plugin génère les fichiers suivants :

• main.tsp : Point d'entrée du service TypeSpec
• models.tsp : Définitions des modèles de données
• operations.tsp : Définitions des opérations REST
• authentication.tsp : Configuration de l'authentification
• adaptivecards.tsp : Définitions des cartes adaptatives
• package.json : Fichier de configuration du package

Exemple d'opération

Voici un exemple d'opération REST générée par le plugin :

@route("/api/items")
@get
op getItems(): Item[];

model Item {
  id: string;
  name: string;
  description?: string;
}

Authentification

Le plugin prend en charge les méthodes d'authentification suivantes :

• OAuth2 (flow implicite ou authorization code)
• Clé API (via en-tête HTTP)
• Authentification de base (Basic Auth)

Cartes adaptatives

Les cartes adaptatives générées permettent d'afficher les résultats des opérations REST dans Microsoft 365 Copilot avec une mise en forme personnalisée. Exemple :

{
  "type": "AdaptiveCard",
  "body": [
    {
      "type": "TextBlock",
      "text": "{item.name}",
      "weight": "Bolder"
    },
    {
      "type": "TextBlock",
      "text": "{item.description}"
    }
  ]
}

Support de plateforme

Ce plugin est conçu pour fonctionner avec :

• TypeSpec (version >= 0.40.0)
• Microsoft 365 Copilot
• Tous les environnements supportant TypeSpec (Windows, macOS, Linux)

Documentation supplémentaire

Pour plus d'informations, consultez la documentation officielle TypeSpec et le guide de développement des plugins Copilot.