Acest articol este un articol oglindă al traducerii automate, vă rugăm să faceți clic aici pentru a sări la articolul original.

Vedere: 20232|Răspunde: 0

[WebAPI] webAPI generează automat documentație de ajutor

[Copiază linkul]
Postat pe 06.10.2016 15:08:16 | | | |
Anterior, am folosit webapi pentru a oferi interfețe în proiect și am descoperit că în proiect există generare automată de documente de ajutor conform metodelor și comentariilor webapi, iar de asemenea poți testa metodele webapi, care sunt foarte puternice, iar acum le voi împărtăși cu tine.
Aruncă o privire mai întâi la documentația generată de webapi.
1. Figura următoare arată pagina de sus a documentului de ajutor pentru generare, unde Values este controlerul, iar lista de sub API arată metoda http (Get, POST etc.), acțiunea cererii și descrierea metodei.
2. Faceți clic pe linkul din caseta roșie pentru a deschide pagina de detalii a metodei API, așa cum este prezentat în figura de mai jos.
3. Apasă pe Test API pentru a deschide pagina următoare

4. Introdu parametrii, apasă butonul Trimite, deschide pagina următoare și poți vedea valoarea returnării.

Pașii pentru a o configura sunt următorii:
Mediu de dezvoltare VS2012 + MVC4 + API WEB
1. Referire la clientul de testare Web API prin NuGet

Referențierea la DLL va genera un fișier de acest tip:
Aceasta este interfața noastră de documentație de ajutor


2. Faceți următoarele setări în proprietățile proiectului, verificați fișierul documentului XMl și setați calea
3. Creează un XmlDocument.xml sub folderul App_Data al proiectului
4. Deschide fișierul AreasHelpPageApp_StartHelpPageConfig.cs și anulează următoarele comentarii de cod

Rulează proiectul, deschide http://localhost:3619/Help și poți vedea documentul API generat automat, care este o imagine a articolului

Descărcare proiect:

WebAPIHelper.part2.rar (893.15 KB, Numărul de descărcări: 1) WebAPIHelper.part1.rar (1.5 MB, Numărul de descărcări: 0)




Precedent:SS-Panel v3 rulând Python servers.py eroare
Următor:Blochează click dreapta, F12 și evită vizualizarea codului sursă
Disclaimer:
Tot software-ul, materialele de programare sau articolele publicate de Code Farmer Network sunt destinate exclusiv scopurilor de învățare și cercetare; Conținutul de mai sus nu va fi folosit în scopuri comerciale sau ilegale, altfel utilizatorii vor suporta toate consecințele. Informațiile de pe acest site provin de pe Internet, iar disputele privind drepturile de autor nu au legătură cu acest site. Trebuie să ștergi complet conținutul de mai sus de pe calculatorul tău în termen de 24 de ore de la descărcare. Dacă îți place programul, te rugăm să susții software-ul autentic, să cumperi înregistrarea și să primești servicii autentice mai bune. Dacă există vreo încălcare, vă rugăm să ne contactați prin e-mail.

Mail To:help@itsvse.com