Auparavant, j’utilisais webapi pour fournir des interfaces dans le projet, et j’ai constaté que dans le projet il y a une génération automatique de documents d’aide selon les méthodes et commentaires webapi, et vous pouvez aussi tester les méthodes webapi, qui sont très puissantes, et je vais maintenant les partager avec vous.
Regardez d’abord la documentation webapi générée.
1. La figure suivante montre la page supérieure du document d’aide à la génération, où Values est le contrôleur, et la liste sous l’API montre la méthode http (Get, POST, etc.), l’action de la requête et la description de la méthode.
2. Cliquez sur le lien dans la case rouge pour ouvrir la page de détails de la méthode API, comme montré dans la figure ci-dessous.
3. Cliquez sur API de Test pour ouvrir la page suivante
4. Entrez les paramètres, cliquez sur le bouton Envoyer, ouvrez la page suivante, et vous pouvez voir la valeur de retour.
Les étapes pour le mettre en place sont les suivantes :
Environnement de développement VS2012 + MVC4 + API WEB
1. Référencer le client de test de l’API Web via NuGet
Référencer la DLL générera un fichier comme ceci :
Voici notre interface de documentation d’aide
2. Configurez les paramètres suivants dans les propriétés du projet, vérifiez le fichier document XMl, et définissez le chemin
3. Créer un XmlDocument.xml sous le dossier App_Data du projet
4. Ouvrez le fichier AreasHelpPageApp_StartHelpPageConfig.cs et annulez les commentaires de code suivants
Faites fonctionner le projet, ouvrez la http://localhost:3619/Help, et vous pouvez voir le document API généré automatiquement, qui est une image de l’article
Téléchargement du projet :