Questo articolo è un articolo speculare di traduzione automatica, clicca qui per saltare all'articolo originale.

Vista: 20232|Risposta: 0

[WebAPI] webAPI genera automaticamente documentazione di aiuto

[Copiato link]
Pubblicato su 06/10/2016 15:08:16 | | | |
In precedenza usavo webapi per fornire interfacce nel progetto, e ho scoperto che nel progetto c'è la generazione automatica di documenti di aiuto secondo i metodi e i commenti webapi, e puoi anche testare i metodi webapi, che sono molto potenti, e ora li condividerò con te.
Dai un'occhiata prima alla documentazione webapi generata.
1. La figura seguente mostra la pagina superiore del documento di aiuto per la generazione, dove Values è il controllore, e la lista sotto l'API mostra il metodo http (Get, POST, ecc.), l'azione della richiesta e la descrizione del metodo.
2. Clicca sul link nella casella rossa per aprire la pagina dettagli del metodo API, come mostrato nella figura sottostante.
3. Clicca su Test API per aprire la pagina seguente

4. Inserisci i parametri, clicca sul pulsante Invia, apri la pagina successiva e puoi vedere il valore di ritorno.

I passaggi per configurarlo sono i seguenti:
Ambiente di sviluppo VS2012 + MVC4 + API WEB
1. Riferimento al client di test Web API tramite NuGet

Fare riferimento alla DLL genererà un file come questo:
Questa è la nostra interfaccia di documentazione di aiuto


2. Effettuare le seguenti impostazioni nelle proprietà del progetto, controllare il file del documento XMl e impostare il percorso
3. Crea un XmlDocument.xml sotto la cartella App_Data del progetto
4. Apri il file AreasHelpPageApp_StartHelpPageConfig.cs e annulla i seguenti commenti al codice

Esegui il progetto, apri il http://localhost:3619/Help e puoi vedere il documento API generato automaticamente, che è un'immagine dell'articolo

Download del progetto:

WebAPIHelper.part2.rar (893.15 KB, Numero di download: 1) WebAPIHelper.part1.rar (1.5 MB, Numero di download: 0)




Precedente:Errore di SS-Panel v3 che esegue Python servers.py
Prossimo:Blocca clic destro, F12, ed evita di visualizzare il codice sorgente
Disconoscimento:
Tutto il software, i materiali di programmazione o gli articoli pubblicati dalla Code Farmer Network sono destinati esclusivamente all'apprendimento e alla ricerca; I contenuti sopra elencati non devono essere utilizzati per scopi commerciali o illegali, altrimenti gli utenti dovranno sostenere tutte le conseguenze. Le informazioni su questo sito provengono da Internet, e le controversie sul copyright non hanno nulla a che fare con questo sito. Devi eliminare completamente i contenuti sopra elencati dal tuo computer entro 24 ore dal download. Se ti piace il programma, ti preghiamo di supportare software autentico, acquistare la registrazione e ottenere servizi autentici migliori. In caso di violazione, vi preghiamo di contattarci via email.

Mail To:help@itsvse.com