Αυτό το άρθρο είναι ένα άρθρο καθρέφτη της αυτόματης μετάφρασης, κάντε κλικ εδώ για να μεταβείτε στο αρχικό άρθρο.

Άποψη: 20232|Απάντηση: 0

[Διαδικτυακό API] Το webAPI δημιουργεί αυτόματα τεκμηρίωση βοήθειας

[Αντιγραφή συνδέσμου]
Δημοσιεύτηκε στις 6/10/2016 3:08:16 μ.μ. | | | |
Προηγουμένως, χρησιμοποιούσα το webapi για να παρέχω διεπαφές στο έργο και διαπίστωσα ότι στο έργο υπάρχει αυτόματη δημιουργία εγγράφων βοήθειας σύμφωνα με μεθόδους και σχόλια webapi και μπορείτε επίσης να δοκιμάσετε μεθόδους webapi, οι οποίες είναι πολύ ισχυρές, και τώρα θα τις μοιραστώ μαζί σας.
Ρίξτε πρώτα μια ματιά στην τεκμηρίωση webapi που δημιουργήθηκε.
1. Το παρακάτω σχήμα δείχνει την επάνω σελίδα του εγγράφου βοήθειας δημιουργίας, όπου το Values είναι ο ελεγκτής και η λίστα κάτω από το API δείχνει τη μέθοδο http (Get, POST, κ.λπ.), την ενέργεια του αιτήματος και την περιγραφή της μεθόδου.
2. Κάντε κλικ στον σύνδεσμο στο κόκκινο πλαίσιο για να ανοίξετε τη σελίδα λεπτομερειών της μεθόδου API, όπως φαίνεται στην παρακάτω εικόνα.
3. Κάντε κλικ στο Test API για να ανοίξετε την ακόλουθη σελίδα

4. Εισαγάγετε τις παραμέτρους, κάντε κλικ στο κουμπί Αποστολή, ανοίξτε την παρακάτω σελίδα και μπορείτε να δείτε την τιμή επιστροφής.

Τα βήματα για τη ρύθμισή του είναι τα εξής:
Περιβάλλον ανάπτυξης VS2012 + MVC4 + WEB API
1. Αναφέρετε το Web API Test Client μέσω του NuGet

Η αναφορά στο DLL θα δημιουργήσει ένα αρχείο όπως αυτό:
Αυτή είναι η διεπαφή τεκμηρίωσης βοήθειας


2. Κάντε τις ακόλουθες ρυθμίσεις στις ιδιότητες του έργου, ελέγξτε το αρχείο εγγράφου XMl και ορίστε τη διαδρομή
3. Δημιουργήστε ένα XmlDocument.xml κάτω από το φάκελο App_Data του έργου
4. Ανοίξτε το αρχείο AreasHelpPageApp_StartHelpPageConfig.cs και ακυρώστε τα ακόλουθα σχόλια κώδικα

Εκτελέστε το έργο, ανοίξτε το http://localhost:3619/Help και μπορείτε να δείτε το έγγραφο API που δημιουργείται αυτόματα, το οποίο είναι μια εικόνα του άρθρου

Λήψη έργου:

WebAPIHelper.part2.rar (893.15 KB, Αριθμός λήψεων: 1) WebAPIHelper.part1.rar (1.5 MB, Αριθμός λήψεων: 0)




Προηγούμενος:Σφάλμα SS-Panel v3 που εκτελεί Python servers.py
Επόμενος:Αποκλείστε το δεξί κλικ, F12 και αποφύγετε την προβολή του πηγαίου κώδικα
Αποκήρυξη:
Όλο το λογισμικό, το υλικό προγραμματισμού ή τα άρθρα που δημοσιεύονται από το Code Farmer Network προορίζονται μόνο για μαθησιακούς και ερευνητικούς σκοπούς. Το παραπάνω περιεχόμενο δεν θα χρησιμοποιηθεί για εμπορικούς ή παράνομους σκοπούς, άλλως οι χρήστες θα υποστούν όλες τις συνέπειες. Οι πληροφορίες σε αυτόν τον ιστότοπο προέρχονται από το Διαδίκτυο και οι διαφορές πνευματικών δικαιωμάτων δεν έχουν καμία σχέση με αυτόν τον ιστότοπο. Πρέπει να διαγράψετε εντελώς το παραπάνω περιεχόμενο από τον υπολογιστή σας εντός 24 ωρών από τη λήψη. Εάν σας αρέσει το πρόγραμμα, υποστηρίξτε γνήσιο λογισμικό, αγοράστε εγγραφή και λάβετε καλύτερες γνήσιες υπηρεσίες. Εάν υπάρχει οποιαδήποτε παραβίαση, επικοινωνήστε μαζί μας μέσω email.

Mail To:help@itsvse.com