.Net के लिए Yandex Search API

शुभ दोपहर
एक .Net परियोजना पर काम करने की प्रक्रिया में, एक विशिष्ट अनुरोध के लिए यैंडेक्स खोज परिणाम प्राप्त करने की आवश्यकता थी। इस लेख में, मैं एक .Net वातावरण से यांडेक्स एपीआई के साथ अनुभव के बारे में बात करना चाहूंगा।
बेशक, शुरू में मैं खुद यांडेक्स एपीआई आवरण को लागू नहीं करना चाहता था (मुझे उम्मीद थी कि किसी ने मुझसे पहले ही ऐसा कर लिया था), इसलिए मैंने लगभग 20 मिनट बिताए यह जानने की कोशिश कर रहा था कि तैयार समाधान मेरे अनुरूप होगा या नहीं। कोई। नतीजतन, मेरे पास खुद को लिखने के अलावा कोई विकल्प नहीं था, क्योंकि Yandex API प्रलेखन सार्वजनिक डोमेन में है और काफी विस्तृत है।

Yandex.XML सेवा मेरी आवश्यकताओं के लिए आदर्श थी। यह खोज क्वेरी स्वीकार करती है और खोज परिणामों के साथ XML प्रतिक्रिया देती है। इसका उपयोग करने के लिए, आपके पास यैंडेक्स पर एक मानक पंजीकरण होना चाहिए और एक एक्सेस कुंजी प्राप्त करना होगा। यह ध्यान दिया जाना चाहिए कि कुंजी उपयोगकर्ता के आईपी से सख्ती से जुड़ी हुई है जिसके लिए इसे प्राप्त किया गया था। प्रति दिन अनुरोधों की संख्या की सीमा शुरू में 10 है, लेकिन फोन नंबर की पुष्टि के बाद यह बढ़कर 1000 हो जाती है।
कुंजी प्राप्त करने के बाद, कार्य 2 चरणों में विभाजित किया गया था: एक अनुरोध भेजना और Yandex.XML से प्रतिक्रिया प्राप्त करना, और इस उत्तर को पार्स करना।

अनुरोध संरचना

Yandex.XML से अनुरोध करने के लिए, आपको यह समझने की आवश्यकता है कि इस अनुरोध में कौन से तत्व शामिल हैं।

< query > - .
< sortby > - :
< rlv > - ,
< tm > - .
< maxpassages > - ( - 5, -2).
< groupings > - < groupby > .
< groupby > - , :
< attr = > - , :
< d > - .
<> - .
< mode = > - :
< flat > - .
< deep > - .
< groups-on-page = > - ( 100).
< docs-in-group = > - .

* This source code was highlighted with Source Code Highlighter .

हमने अनुरोध की संरचना को सुलझा लिया, अब इसे भेजने का समय आ गया है। ऐसा करने के दो तरीके हैं: POST विधि और GET विधि। मैं प्रत्येक के बारे में अलग से बताऊंगा।

पोस्ट विधि

पोस्ट विधि का सार यह है कि अनुरोध XML प्रारूप में उत्पन्न होता है, धारा को लिखा जाता है और सेवा में भेजा जाता है। निराधार न होने के लिए, मैं एक कोड दूंगा जिसमें उपरोक्त होता है:

ServicePointManager.Expect100Continue = false ;

/* , IP,
API.*/
string url = @"http://xmlsearch.yandex.ru/xmlsearch?
user=**********&
key=**********************************" ;

// XML
string command =
@"<?xml version=" "1.0" " encoding=" "UTF-8" "?>
<request>
<query>- </query>
<groupings>
<groupby attr=" "d" "
mode=" "deep" "
groups-on-page=" "10" "
docs-in-group=" "1" " />
</groupings>
</request>" ;

byte [] bytes = Encoding .UTF8.GetBytes(command);
// , .
HttpWebRequest request = (HttpWebRequest)WebRequest.Create(url);
request.Method = "POST" ;
request.ContentLength = bytes.Length;
request.ContentType = "text/xml" ;
// XML-
using ( Stream requestStream = request.GetRequestStream())
{
requestStream.Write(bytes, 0, bytes.Length);
}

//
HttpWebResponse response =(HttpWebResponse)request.GetResponse();

* This source code was highlighted with Source Code Highlighter .

पहली पंक्ति आवश्यक है क्योंकि HttpWebRequest ऑब्जेक्ट, POST विधि का उपयोग करके एक अनुरोध भेजते समय, HTTP शीर्ष लेख "उम्मीद: 100-जारी रखें" को इसमें जोड़ा जाता है, जो कुछ सेवाओं (Yandex.XML सहित) को भ्रमित करता है और एक त्रुटि का कारण बनता है "(417) उम्मीद विफलता "।

विधि प्राप्त करें

GET विधि POST विधि से भिन्न है जिसमें अनुरोध एक सरल स्ट्रिंग है, न कि XML प्रारूप स्ट्रिंग। सेवा प्राप्त होने पर, सेवा स्वयं अनुरोध पाठ से XML बनाता है (स्ट्रिंग अनुरोध के प्रत्येक तत्व को XML विशेषता में परिवर्तित करता है) और प्रतिक्रिया भेजता है (XML प्रारूप में)। कोड उदाहरण:

//, IP.
string key = "***********************************" ;
// .
string user = "*****************" ;
// .
string url = @"http://xmlsearch.yandex.ru/xmlsearch?
query={0}&
groupby=attr%3Dd.
mode%3Ddeep.
groups-on-page%3D10.
docs-in-group%3D1&
user={1}&
key={2}" ;
// .
string completeUrl = String .Format(url, searchQuery, user, key);
//, .
HttpWebRequest request = (HttpWebRequest)WebRequest.Create(completeUrl);
// .
HttpWebResponse response = (HttpWebResponse)request.GetResponse();

* This source code was highlighted with Source Code Highlighter .

तो, सेवा से प्रतिक्रिया प्राप्त होती है। अब आपको इसे खोज परिणामों के बारे में सभी आवश्यक जानकारी निकालने की आवश्यकता है। .Net वातावरण में XML दस्तावेजों के साथ काम करने के लिए एक शक्तिशाली तंत्र है, इसलिए इसके साथ कोई विशेष समस्याएं नहीं थीं। सबसे पहले, एक ऑब्जेक्ट बनाएं जिसके माध्यम से हम प्राप्त किए गए HttpWebResponse प्रतिक्रिया के आधार पर XML प्रतिक्रिया के साथ काम करेंगे:

XmlReader xmlReader = XmlReader.Create(response.GetResponseStream());
XDocument xmlResponse = XDocument .Load(xmlReader);

* This source code was highlighted with Source Code Highlighter .

सभी प्राप्त अवशेष XML प्रतिक्रिया को पार्स करना है। लेकिन ऐसा करने से पहले, आपको इस उत्तर की संरचना को जानना होगा। यह पूरी तरह से Yandex.XML के लिए प्रलेखन में वर्णित है। मैं केवल यह कह सकता हूं कि परियोजना में मुझे खोज परिणामों के बारे में सामान्य जानकारी की आवश्यकता नहीं थी, और इसे अलग-अलग संरचनाओं के रूप में व्यक्तिगत खोज परिणामों के साथ काम करने की योजना बनाई गई थी। प्रत्येक खोज परिणाम में, मैं निम्नलिखित में रुचि रखता था:

• < url > - URL
• < title > -
• < headline > -
• < modtime > -
• < saved-copy-url > -

* This source code was highlighted with Source Code Highlighter .

सबसे पहले, एक संरचना तैयार की गई थी जिसमें खोज परिणाम लिखे जाएंगे:

public struct YaSearchResult
{
//url
public string DisplayUrl,
//saved-copy-url
CacheUrl,
//title
Title,
//headline
Description,
//modtime
IndexedTime;

public YaSearchResult( string url,
string cacheUrl,
string title,
string description,
string indexedTime)
{
this .DisplayUrl = url;
this .CacheUrl = cacheUrl;
this .Title = title;
this .Description = description;
this .IndexedTime = indexedTime;
}
}

* This source code was highlighted with Source Code Highlighter .

XML दस्तावेज़ में ही, प्रत्येक खोज परिणाम को समूह कहा जाता है और इसमें निम्न संरचना होती है:

<group>
<categ attr= "" name= "" />
<doccount> </doccount>
<relevance priority= "" />
-<doc id= "" >
<relevance priority= "" />
<url> </url>
<domain> </domain>
<title> </title>
<modtime> </modtime>
<size> </size>
<charset> </charset>
+<passages>
+<properties>
<mime-type> </mime-type>
<saved-copy-url> </saved-copy-url>
</doc>
</group>

* This source code was highlighted with Source Code Highlighter .

और अंत में, पार्सिंग विधि खुद (शुरुआत में, अपने एक्सएमएल मानों को बाहर निकालने के लिए एक सहायक विधि):

// doc,
// GetValue , ,
public static string GetValue( XElement group, string name)
{
try
{
return group.Element(«doc»).Element(name).Value;
}
// ,
// .
catch
{
return string .Empty;
}
}

* This source code was highlighted with Source Code Highlighter .

public static List <YaSearchResult> Search( string searchQuery)
{

// YaSearchResult, .
List <YaSearchResult> ret = new List <YaSearchResult>();

// XML' "group" -
var groupQuery = from gr in response.Elements().
Elements( "response" ).
Elements( "results" ).
Elements( "grouping" ).
Elements( "group" )
select gr;

// group SearchResult
for ( int i = 0; i < groupQuery.Count(); i++)
{
string urlQuery = GetValue(groupQuery.ElementAt(i), "url" );
string titleQuery = GetValue(groupQuery.ElementAt(i), "title" );
string descriptionQuery = GetValue(groupQuery.ElementAt(i), "headline" );
string indexedTimeQuery = GetValue(groupQuery.ElementAt(i), "modtime" );
string cacheUrlQuery = GetValue(groupQuery.ElementAt(i),
"saved-copy-url" );
ret.Add( new YaSearchResult(urlQuery, cacheUrlQuery, titleQuery, descriptionQuery, indexedTimeQuery));
}

return ret;
}

* This source code was highlighted with Source Code Highlighter .

खोज परिणाम पत्रक प्राप्त हुआ!

निष्कर्ष

यदि कोई .Net से यांडेक्स एपीआई के साथ काम करने के विषय में रुचि रखता है, तो अगले लेख में मैं लिख सकता हूं कि यैंडेक्स एपीआई जियोकोडिंग / रिवर्स जियोकोडिंग के साथ कैसे काम किया जाए।

अंत में, मैं यह कहना चाहूंगा कि मैं .Net के लिए यैंडेक्स एपीआई का एक सुंदर पूर्ण आवरण लिखने की योजना बनाता हूं, न केवल यांडेक्स.एक्सएमएल बल्कि अन्य सेवाएं भी।