एएसपी .NET 5 वेब एपीआई सहायता पृष्ठ

Question

मैंने अभी एएसपी.NET 5 पर काम करना शुरू कर दिया है। मैं अपने तरीकों के लिए एक सहायता पृष्ठ चाहता हूं, मैंने सहायता पृष्ठों को बनाने के लिए कुछ उदाहरण देखे हैं, लेकिन उनमें से अधिकांश एमवीसी विशिष्ट हैं । मैं Microsoft.AspNet.WebApi.HelpPage पैकेज से गुजर चुका हूं, यह सहायता पृष्ठ के लिए एक क्षेत्र बनाता है लेकिन मैं एमवीसी पैटर्न का उपयोग नहीं कर रहा हूं।

कोई सुझाव मैं इस क्षेत्र के दृष्टिकोण के अलावा सहायता पृष्ठ कैसे बना सकता हूं?

Answer 1

मैं Swagger और SwaggerUI पर सुझाव देने का सुझाव दूंगा। स्वैगर एक खुला मानक है, जेएसओएन का उपयोग एपीआई दस्तावेज करने के लिए, पेपैल और माइक्रोसॉफ्ट की पसंद से किया जाता है (अज़ूर पोर्टल में Logic apps देखें)।

:

वहाँ नेट (जो दोनों के मैं का इस्तेमाल किया है) के लिए कुछ खुला स्रोत कार्यान्वयन, जो स्वयं अपने एपीआई दस्तावेज़ होगा, बस अपनी परियोजना के लिए NuGet संकुल और विन्यास का एक छोटा सा जोड़कर हैं

• https://github.com/domaindrivendev/Swashbuckle
• https://github.com/domaindrivendev/Ahoy

Swashbuckle मूल परियोजना है और एहोय नए संस्करण को लक्षित ASPNET5 है। NuGet से पैकेज डाउनलोड करते समय आपको अभी भी स्वाशबकल मिल जाएगा, बस सुनिश्चित करें कि आप "प्री-रिलीज शामिल करें" पर टिकटें, और यदि आपको मूल गिटहब प्रोजेक्ट पर कोई दस्तावेज देखने की आवश्यकता है।

स्वैगरयूआई (जिसे स्वाशबकल में भी शामिल किया गया है) एक इंटरफेस जोड़ता है जिसका उपयोग आप अपने एपीआई को नेविगेट करने और परीक्षण करने के लिए कर सकते हैं, डिफ़ॉल्ट रूप से यह आपकी परियोजना चलने पर "/ swagger/ui" से उपलब्ध है। , https://github.com/mattridgway/ASPNET5-SwaggerUI