Cet article est un article miroir de traduction automatique, veuillez cliquer ici pour accéder à l’article original.

Vue: 20232|Répondre: 0

[WebAPI] webAPI génère automatiquement une documentation d’aide

[Copié le lien]
Publié sur 06/10/2016 15:08:16 | | | |
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 :

WebAPIHelper.part2.rar (893.15 KB, Nombre de téléchargements: 1) WebAPIHelper.part1.rar (1.5 MB, Nombre de téléchargements: 0)




Précédent:ss-panel v3 exécutant Python servers.py erreur
Prochain:Bloquez le clic droit, F12, et évitez de voir le code source
Démenti:
Tous les logiciels, supports de programmation ou articles publiés par Code Farmer Network sont uniquement destinés à l’apprentissage et à la recherche ; Le contenu ci-dessus ne doit pas être utilisé à des fins commerciales ou illégales, sinon les utilisateurs assumeront toutes les conséquences. Les informations sur ce site proviennent d’Internet, et les litiges de droits d’auteur n’ont rien à voir avec ce site. Vous devez supprimer complètement le contenu ci-dessus de votre ordinateur dans les 24 heures suivant le téléchargement. Si vous aimez le programme, merci de soutenir un logiciel authentique, d’acheter l’immatriculation et d’obtenir de meilleurs services authentiques. En cas d’infraction, veuillez nous contacter par e-mail.

Mail To:help@itsvse.com