👩🏾‍🔬 ⏫ 😧 बुश जीरा एपीआई क्लाइंट: पीएचपी में जीरा में जादू 👩🏿‍🤝‍👩🏽 🙌🏻 🍼

यदि आप Habré पर खोज स्ट्रिंग में "जीरा Badoo" दर्ज करते हैं, तो परिणाम एक से अधिक पृष्ठ लेंगे: हम लगभग हर जगह इसका उल्लेख करते हैं, क्योंकि यह हमारी प्रक्रियाओं में एक महत्वपूर्ण भूमिका निभाता है। और हम में से हर कोई उससे थोड़ा अलग चाहता है।

डेवलपर, जिसने समीक्षा के लिए कार्य प्राप्त किया है, को उम्मीद है कि कार्य में एक शाखा का संकेत दिया गया है, अंतर और परिवर्तन लॉग के लिंक हैं। जिस डेवलपर ने कोड लिखा है, वह समीक्षा के बाद जीरा में टिप्पणियों को देखने की उम्मीद करता है। परीक्षक, जो उनके बाद कार्य प्राप्त करता है, परीक्षा परिणाम देखना चाहता है और अन्य इंटरफेस में जाने के बिना आवश्यक विधानसभाओं को चलाने में सक्षम है। उत्पाद प्रबंधक आमतौर पर एक ही बटन दबाकर एक ही समय में दस विकास कार्य करना चाहते हैं।

और यह सब आज उपलब्ध है और स्वचालित रूप से होता है। हमने लगातार विकसित जीरा एपीआई का उपयोग करके और इसके वेबहुक का उपयोग करके PHP में अधिकांश जादू को लागू किया। और आज हम इस एपीआई के लिए ग्राहक के हमारे संस्करण को समुदाय के साथ साझा करना चाहते हैं।

सबसे पहले, हम केवल उन विचारों और दृष्टिकोण के बारे में बात करना चाहते थे जो हम उपयोग करते हैं, और फिर फैसला किया कि निश्चित रूप से स्पष्टता के लिए इस तरह के लेख के लिए पर्याप्त कोड नहीं था। तो वहाँ एक खुला-स्रोत संस्करण जेरा PHP क्लाइंट था । उनके वर्णन के साथ मदद करने के लिए शैग्यरेट को बहुत धन्यवाद। और कैट में आपका स्वागत है!

अधिक विवरण और संदर्भ।

यदि आपको जीरा के साथ क्या करना है, इसके बारे में आपको अधिक जानकारी चाहिए, तो आप उन्हें हमारे अन्य लेखों में पा सकते हैं:

habr.com/ru/company/badoo/blog/169417
habr.com/ru/company/badoo/blog/433540
habr.com/ru/company/badoo/blog/424655

वह क्या कर सकता है?

वास्तव में, लिट्रा जीरा पीएचपी क्लाइंट जीरा एपीआई प्रतिक्रियाओं के लिए रेडीमेड रैपर क्लासेज का एक सेट है, जिसमें से अधिकांश ActiveRecord की तरह व्यवहार कर सकते हैं: वे जानते हैं कि अपने बारे में डेटा कैसे प्राप्त करें और उन्हें सर्वर पर अपडेट कैसे करें, स्तर पर आलसीकरण और डेटा कैशिंग का समर्थन करें। कोड। सभी जीरा इकाइयां जिन्हें आपको लगातार काम करना पड़ता है: मुद्दे, स्थिति, प्राथमिकता, चैंज, उपयोगकर्ता, संस्करण, घटक , आदि (लगभग सब कुछ जो आप इंटरफ़ेस में देखते हैं)।

इसके अलावा, Badoo Jira PHP क्लाइंट सभी Jira कस्टम फ़ील्ड के लिए एक एकल श्रेणी पदानुक्रम प्रदान करता है और प्रत्येक कस्टम फ़ील्ड के लिए वर्ग परिभाषाएँ उत्पन्न करने में सक्षम होता है जिनकी आपको आवश्यकता होती है।

$Issue = new \Badoo\Jira\Issue('SMPL-1'); $Issue->addComment('Sample comment text'); $Issue->attachFile('kitten.jpeg', 'pretty!', 'image/jpeg'); if ($Issue->getStatus()->getName() === 'Open') { $Issue->step('In Progress'); }

 $DeveloperField = new \Example\CustomFields\Developer($Issue); $DeveloperField->setValue('username')->save();

 $User = \Badoo\Jira\User::get('username'); $User->watchIssue('SMPL-1'); $User->assign('SMPL-2');

इसके लिए धन्यवाद, PHP से एपीआई के साथ बातचीत सरल और अधिक सुविधाजनक हो जाती है, और आपके जीरा के लिए प्रलेखन सीधे कोड में चला जाता है, जो आपको कई मानक कार्यों के लिए आईडीई में ऑटो-पूर्णता का उपयोग करने की अनुमति देता है।

लेकिन पहले बातें पहले।

एपीआई सुविधाओं का सामना करना पड़ा

जब हमने जीरा एपीआई का सक्रिय रूप से उपयोग करना शुरू किया, तो यह केवल सोप प्रोटोकॉल के माध्यम से उपलब्ध था। इसका REST संस्करण बाद में दिखाई दिया, और हम इसके पहले उपयोगकर्ताओं में से थे। उस समय, PHP में सार्वजनिक रूप से उपलब्ध REST क्लाइंट बहुत कम उपलब्ध थे। कुछ ऐसा खोजना और भी मुश्किल था जो आसानी से हमारे कोड बेस में एकीकृत हो सकता है, धीरे-धीरे SOAP से REST तक बढ़ रहा है। इसलिए हमारे पास कोई विकल्प नहीं था: हमने अपने स्वयं के ग्राहक विकसित करने का निर्णय लिया।

इसलिए हम SOAP क्लाइंट से सभी प्रकार के हैक और बैसाखी को खींचकर और छोड़ कर रहते थे और REST की ख़ासियतों के कारण नए प्राप्त करते थे। नतीजतन, हमने कुछ बहुत ही बोल्ड कक्षाएं विकसित की हैं जो डुप्लिकेट कोड के एक समूह के साथ हैं, और इस गड़बड़ को साफ करने की आवश्यकता है।

कस्टम क्षेत्र हमेशा हमारे लिए सबसे दर्दनाक जगह रहे हैं: हमारे पास उनमें से 300 से अधिक हैं (इस लेख को लिखने के समय - 338), और यह संख्या धीरे-धीरे बढ़ रही है।

अजीब त्रुटि संदेश

एपीआई के साथ बातचीत के लंबे इतिहास में, हमने कई अलग-अलग चीजों को देखा है। अधिकांश त्रुटि संदेश पर्याप्त हैं, लेकिन ऐसे हैं जिनके लिए आपको अपने मस्तिष्क को बहुत अधिक तनाव देना होगा।

उदाहरण के लिए, यदि जीरा अचानक आपके उपयोगकर्ता में एक रोबोट को पहचानता है, तो वह उसे एक कैप्चा दिखाना शुरू कर देगा। इस स्थिति में, एपीआई तक पहुँचने के दौरान, यह बेशर्मी से स्वीकार-एनकोडिंग: एप्लिकेशन / जसन हेडर को अनदेखा कर देता है और आपको HTML प्रदान करता है। स्वाभाविक रूप से, JSON की प्रतीक्षा कर रहा क्लाइंट इस "हैलो" के लिए तैयार नहीं हो सकता है।

और यहाँ एक कस्टम क्षेत्र के साथ काम करने का एक उदाहरण है:

जब आप कोड लिखते हैं और "अभी परीक्षण करते हैं" तो आप इसका परीक्षण कर रहे हैं, यह समझना बहुत आसान है कि customfield_12664 डेवलपर्स है । और अगर इस तरह की त्रुटि उत्पादन पर कहीं से बाहर निकलती है (उदाहरण के लिए, क्योंकि किसी ने कॉन्फ़िगरेशन को बदल दिया और चयन क्षेत्र के लिए स्वीकार्य मानों की सूची बदल दी), अक्सर क्षेत्र की पहचान करने का एकमात्र तरीका जीरा में जाना है और वहां से नाम का पता लगाना है। इसके अलावा, इसके इंटरफेस में, आईडी प्रदर्शित नहीं होते हैं - केवल नाम।

यह पता चला है कि जब आप उस फ़ील्ड के नाम का पता लगाना चाहते हैं जो त्रुटि का कारण बना और इसके कॉन्फ़िगरेशन को सही करता है, तो आप ऐसा एपीआई के अनुरोध के माध्यम से कर सकते हैं, या कुछ अन्य गैर-स्पष्ट तरीकों का उपयोग कर सकते हैं: पृष्ठ के स्रोत कोड के माध्यम से अफवाह करना, एक मनमाना क्षेत्र के लिए सेटिंग्स खोलना। और एड्रेस बार में URL को सही करना आदि, इस प्रक्रिया को सुविधाजनक नहीं कहा जा सकता है, और हर बार ऐसे सरल कार्य के लिए बहुत अधिक समय लगता है।

लेकिन अस्पष्ट क्षेत्र के नाम समस्याओं तक सीमित नहीं हैं। यदि आप फ़ील्ड को अपडेट करने के लिए डेटा संरचना में कोई गलती करते हैं, तो एपीआई के साथ बातचीत इस तरह दिखती है:

कई अलग-अलग डेटा प्रारूप

और यह मत भूलो कि विभिन्न प्रकार के अद्यतन क्षेत्रों को अलग-अलग डेटा संरचनाओं की आवश्यकता होती है।

 $Jira->issue()->edit( 'SMPL-1', [ 'customfield_10200' => ['name' => 'denkoren'], 'customfield_10300' => ['value' => 'PHP'], 'customfield_10400' => [['value' => 'Android'], ['value' => 'iOS']], 'security' => ['id' => 100500], 'description' => 'Just text', ], );

उनके लिए एपीआई उत्तर निश्चित रूप से अलग भी हैं।

इसे केवल तभी ध्यान में रखना संभव है जब आप जीरा एपीआई के साथ लगातार काम कर रहे हों और लंबे समय तक विचलित न हों। अन्यथा, ये सुविधाएँ कुछ हफ़्ते में स्मृति से बाहर हो जाती हैं। इसके अलावा, आपको सही संरचना के साथ इसे "फ़ीड" करने के लिए किस प्रकार के फ़ील्ड की आवश्यकता है, यह याद रखना चाहिए। जब आपके पास सैकड़ों कस्टम फ़ील्ड होते हैं, तो आपको अक्सर या तो उस कोड को देखना पड़ता है जहां यह अभी भी उपयोग किया गया था, या जीरा व्यवस्थापक पैनल में चढ़ गया।

इससे पहले कि हम अपने ग्राहक को लिखते, स्टैक ओवरफ्लो और एटलसियन कम्युनिटी कस्टम फील्ड अपडेट करने के बारे में मेरे सबसे अच्छे दोस्त थे। अब यह जानकारी आसानी से और तेज़ी से चालू हो जाती है, लेकिन हमने REST API पर तब स्विच किया, जब यह अभी भी काफी नया और सक्रिय रूप से विकसित था: Google में एक उपयुक्त cURL अनुरोध को खोजने में दस मिनट का समय लगा था, और फिर आपको अपनी आंखों के साथ ब्रैकेट के इस गुच्छा को पार्स करना था और परिवर्तित करना था। PHP के लिए सही संरचना में, जो अक्सर पहली कोशिश में काम नहीं करता था।

सामान्य तौर पर, कस्टम फ़ील्ड के साथ सहभागिता वह प्रक्रिया है, जिसके पुनर्गठन की आवश्यकता पहले थी।

क्लाइंट में क्या शामिल है?

कस्टम क्षेत्रों के साथ काम करने के लिए कक्षाएं

सबसे पहले, हम एपीआई के साथ बातचीत के लिए डेटा संरचनाओं को याद करने से छुटकारा पाना चाहते थे और त्रुटियां होने पर पठनीय फ़ील्ड नाम प्राप्त कर सकते थे।

नतीजतन, हमने सभी कस्टम फ़ील्ड के लिए एक एकल श्रेणी पदानुक्रम बनाया। यह तीन परतों निकला:

सभी के लिए एक सामान्य सार माता-पिता: \ Badoo \ जीरा \ कस्टमफ़िल्ड्स \ कस्टमफ़िल्ड ।
प्रत्येक प्रकार के क्षेत्र के लिए एक सार वर्ग द्वारा: SelectField, UserField, TextField , आदि।
प्रत्येक विशिष्ट क्षेत्र के लिए वर्ग द्वारा: उदाहरण के लिए, डेवलपर या समीक्षक ।

इन कक्षाओं को स्वतंत्र रूप से लिखा जा सकता है, या एक विशेष स्क्रिप्ट-जनरेटर का उपयोग करके स्वचालित रूप से बनाया जा सकता है (हम इसमें वापस आ जाएंगे)।

इस संरचना के लिए धन्यवाद, अपने कस्टम फील्ड ऑफ़ टाइप लिस्ट (बहुविकल्पी) के मूल्य को अपडेट करने के लिए कोड सिखाने के लिए, यह SelectField से विरासत में मिली PHP क्लास बनाने के लिए पर्याप्त है। वास्तव में, हर कस्टम जीरा क्षेत्र PHP कोड में एक नियमित ActiveRecord में बदल जाता है।

 namespace \Example\CustomFields; class Developer extends \Badoo\Jira\CustomFields\SingleUserField { const ID = 'customfield_10200'; const NAME = 'Developer'; } // ,  ,  !

उसी कक्षा में, हम फ़ील्ड के बारे में जानकारी संग्रहीत करते हैं: डिफ़ॉल्ट रूप से, यह एक आईडी, फ़ील्ड का नाम और उपलब्ध मानों की एक सूची है, अगर यह सीमित है (उदाहरण के लिए, चेकबॉक्स और चयन के लिए )।

जीरा इंटरफेस और उसके अनुरूप वर्ग में खेतों के उदाहरण

 class IssueFor extends \Badoo\Jira\CustomFields\SingleSelectField { const ID = 'customfield_10662'; const NAME = 'Issue for'; /* Available field values. */ const VALUE_BI = 'BI'; const VALUE_C_C = 'C\C++'; const VALUE_HTML_CSS = 'HTML\CSS'; const VALUE_JS = 'JS'; const VALUE_OTHER = 'Other'; const VALUE_PHP = 'PHP'; const VALUE_TRANSLATION = 'Translation'; const VALUES = [ self::VALUE_BI, self::VALUE_C_C, self::VALUE_HTML_CSS, self::VALUE_JS, self::VALUE_OTHER, self::VALUE_PHP, self::VALUE_TRANSLATION, ]; public function getItemsList() : array { return static::VALUES; } }

यह पता चला है कि इस तरह के प्रलेखन आपके जीरा के लिए है, सीधे PHP कोड में स्थित है। जब यह इतना करीब होता है, तो यह बहुत सुविधाजनक है और त्रुटियों की संख्या को कम करते हुए, विकास को गति प्रदान करता है।

इसके अलावा, त्रुटि संदेश अधिक स्पष्ट हो जाते हैं: कुछ भी कहने के बजाय, 'customfield_12664' क्रैश, उदाहरण के लिए, कुछ इस तरह से:

 Uncaught Badoo\Jira\Exception\CustomField: User 'asdkljfh' not found in Jira. Can't change 'Developer' field value.

सिस्टम ऑब्जेक्ट्स के साथ काम करने के लिए कक्षाएं

जीरा में एक जटिल संरचना के साथ बहुत सारे डेटा हैं: उदाहरण के लिए, स्थिति और सुरक्षा प्रणाली फ़ील्ड, कार्यों, उपयोगकर्ताओं, संस्करणों, अनुलग्नकों (फ़ाइलों) के बीच लिंक।

हमने उन्हें कक्षाओं में भी लपेटा:

 //   $Status = $Issue->getStatus(); $Status->getName(); $Status->getId();

 // changelog  $History = \Badoo\Jira\Issue\History::forIssue('SMPL-1'); $seconds_in_status = $History->getTimeInStatus('Open');

 //  Jira $User = new \Badoo\Jira\User('sampleuser'); $User->assign('SMPL-1');

इस तरह के रैपर आपके आईडीई को यह बताने की सुविधा देते हैं कि कौन सा डेटा उपलब्ध है और आपको अपने कोड में फ़ंक्शन इंटरफेस को सख्ती से औपचारिक बनाने की अनुमति देता है। हम सक्रिय रूप से प्रकार की घोषणाओं का उपयोग करते हैं, लगभग हमेशा यह हमें आईडीई के हाइलाइटिंग के लिए कोड धन्यवाद लिखते हुए भी एक त्रुटि देखने की अनुमति देता है। और यदि आप अभी भी त्रुटि से चूक गए हैं, तो यह ठीक उसी स्थान पर निकलेगा, जहां यह पहली बार दिखाई दिया था, और न कि आपने अंत में अपना कोड कहां छोड़ा था।

अभी भी स्थिर विधियाँ हैं जो आपको किसी मानदंड से किसी वस्तु को जल्दी प्राप्त करने की अनुमति देती हैं:

 $users = \Badoo\Jira\User::search('<pattern>'); //    login, email  display name $Version = \Badoo\Jira\Version::byName('<project>', '<version name>'); //        $components = \Badoo\Jira\Component::forProject('<project>'); //

ये विधियां सामान्य नियमों का पालन करती हैं ताकि उन्हें ढूंढना आसान हो:

:: खोज () , यदि आपको कई क्षेत्रों की वस्तुओं को खोजने की आवश्यकता है: \ Login \ Jira \ मुद्दा :: खोज () JQL का उपयोग करते हुए कार्यों की खोज, जहां आप कई खोज मापदंड निर्दिष्ट कर सकते हैं, और \ Badoo \ Jira \ उपयोगकर्ता :: खोज () 'नाम' (लॉगिन), 'ईमेल' और 'प्रदर्शन' (वेब पर प्रदान किया जाने वाला नाम) द्वारा एक ही समय में उपयोगकर्ता को खोजता है;
:: * द्वारा () , अगर आपको आईडी द्वारा वस्तु प्राप्त करने की आवश्यकता नहीं है, लेकिन कुछ अन्य मानदंड से: \ Badoo \ जीरा \ उपयोगकर्ता :: byEmail () अपने ईमेल पते से एक उपयोगकर्ता की तलाश में है;
:: * के लिए () किसी वस्तु से जुड़ी सभी वस्तुओं को देखता है: \ Badoo \ जीरा \ संस्करण :: forProject
एक विशिष्ट परियोजना से सभी संस्करण देता है;
:: fromStdClass () कच्चे डेटा से एक ऑब्जेक्ट बनाएगा, जिसमें एक उपयुक्त संरचना है, लेकिन एपीआई से प्राप्त नहीं है, लेकिन, उदाहरण के लिए, webhook से : POST अनुरोध के मुख्य भाग में, Jira, JSON को घटना के बारे में अलग-अलग जानकारी भेजता है, जिसमें कार्य का मुख्य भाग भी शामिल है। सभी क्षेत्रों सहित। इस डेटा के आधार पर, आप \ Badoo \ Jira \ समस्या ऑब्जेक्ट बना सकते हैं और हमेशा की तरह उपयोग कर सकते हैं।

कक्षा \ Badoo \ जीरा \ मुद्दा

यह मुझे लगता है कि PhpStorm के निम्नलिखित स्क्रीनशॉट अपने आप में काफी स्पष्ट है:

संक्षेप में, \ Badoo \ जीरा \ मुद्दा वस्तु एक प्रणाली में ऊपर वर्णित सब कुछ बांधता है। यह कार्य के बारे में सभी जानकारी संग्रहीत करता है, इसमें सबसे अधिक बार उपयोग किए जाने वाले डेटा तक त्वरित पहुंच के लिए तरीके, स्थितियों के बीच कार्यों को स्थानांतरित करना आदि हैं।

सरलतम मामले में एक वस्तु बनाने के लिए, यह केवल कार्य की कुंजी को जानने के लिए पर्याप्त है।

अपनी जेब में केवल एक कार्य कुंजी के साथ एक वस्तु बनाएं

 $Issue = new \Badoo\Jira\Issue('SMPL-1');

आप किसी भी खंडित डेटासेट का उपयोग कर सकते हैं। उदाहरण के लिए, एपीआई से आने वाले कार्यों के बीच लिंक जानकारी में केवल कुछ फ़ील्ड हैं: आईडी, सारांश, स्थिति, प्राथमिकता और जारी करना। \ Badoo \ जीरा \ मुद्दा आपको इस डेटा से एक ऑब्जेक्ट इकट्ठा करने की अनुमति देता है ताकि इसे तुरंत वापस किया जा सके, और बाकी के लिए, एपीआई का उपयोग करें।

कुछ फ़ील्ड के लिए एक ऑब्जेक्ट, कैशिंग मान बनाएँ

  $IssueFromLink = \Badoo\Jira\Issue::fromStdClass( $LinkInfo, [ 'id', 'key', 'summary', 'status', 'priority', 'issuetype', ] );

यह कोड में डेटा के आलसी आरंभीकरण और कैशिंग के माध्यम से प्राप्त किया जाता है। यह दृष्टिकोण विशेष रूप से सुविधाजनक है कि आप अपने कोड में केवल उन वस्तुओं के सेट का आदान-प्रदान कर सकते हैं, जिनके साथ वे बनाए गए फ़ील्ड्स के सेट के बावजूद।

लापता कार्य डेटा प्राप्त करें

 $IssueFromLink->getSummary(); //    API,    $IssueFromLink->getDescription(); //  API    description

हम एपीआई में कैसे जाते हैं

जीरा एपीआई में, एक कार्य के लिए सभी फ़ील्ड नहीं प्राप्त करना संभव है, लेकिन केवल वे फ़ील्ड्स जिनकी वर्तमान में आवश्यकता है: उदाहरण के लिए, केवल कुंजी और सारांश। हालांकि, हम जानबूझकर जीटर में सिर्फ एक क्षेत्र के लिए जीरा नहीं जाते हैं। उपरोक्त उदाहरण में, getDescription () एक बार में सभी फ़ील्ड के बारे में जानकारी अपडेट कर देगा। चूँकि \ Login \ Jira \ Issue को इस बात का ज़रा सा भी अंदाज़ा नहीं है कि आपको आगे और क्या चाहिए, इसलिए एपीआई से सब कुछ तुरंत प्राप्त करना अधिक लाभदायक है, क्योंकि हम वैसे भी वहाँ गए थे। हां, "टिकट केवल विवरण प्राप्त करें" और सैकड़ों सैकड़ों टिकटों के लिए क्वेरी "डिफ़ॉल्ट रूप से सभी फ़ील्ड प्राप्त करें" अलग-अलग समय लेती है, लेकिन एक के लिए यह अंतर इतना ध्यान देने योग्य नहीं है।

 //Time for single field: 0.40271635055542 (second) //Time for all default fields: 0.84159119129181 (second)

आंकड़ों से यह स्पष्ट है कि केवल तीन फ़ील्ड (अनुरोध में एक) प्राप्त करते समय, प्रत्येक के लिए एपीआई पर जाने के बजाय एक ही बार में सब कुछ प्राप्त करना अधिक लाभदायक होता है। इस माप का परिणाम, वास्तव में, जीरा के कॉन्फ़िगरेशन और उस सर्वर पर निर्भर करता है जिस पर वह चलता है। कार्य से कार्य तक और माप से माप तक, सभी डिफ़ॉल्ट फ़ील्ड्स के लिए संख्याएँ बदलती हैं और समय एकल फ़ील्ड के लिए तीन समय से कम हो जाता है, और अक्सर दो से भी कम होता है।

हालांकि, बड़ी संख्या में कार्यों के साथ काम करते समय, अंतर सेकंड में मापा जा सकता है। इसलिए, जब आप जानते हैं कि आपको केवल 500 टिकटों के लिए कुंजी और विवरण की आवश्यकता है, तो उन्हें एक प्रभावी क्वेरी के साथ प्राप्त करने की क्षमता \ Badoo \ जीरा \ मुद्दा :: खोज () और \ सगाई \ जीरा \ मुद्दा :: byKeys () विधियों में रहती है ।

\ Badoo \ जीरा \ मुद्दा - आम तौर पर कुछ सार जीरा में कार्यों के बारे में। लेकिन आपकी (हमारी तरह) जीरा सार नहीं है - इसमें कस्टम फ़ील्ड्स और अपने स्वयं के वर्कफ़्लो का एक बहुत विशिष्ट सेट है। आप अक्सर लानत किए गए कुछ क्षेत्रों और बदलावों का उपयोग करते हैं, इसलिए उनके लिए हर लंबे रास्ते के बाद जाना बहुत सुविधाजनक नहीं है। इसलिए, \ Badoo \ जीरा \ मुद्दा आसानी से एक विशिष्ट जीरा कॉन्फ़िगरेशन के लिए अपने स्वयं के तरीकों के साथ बढ़ाया जा सकता है।

कस्टम फ़ील्ड को जल्दी से प्राप्त करने के लिए विधि द्वारा वर्ग विस्तार का एक उदाहरण

 namespace \Deploy; class Issue extends \Badoo\Jira\Issue { // … /** * Get 'Developer' custom field as object */ function getDeveloperField() : \Deploy\CustomFields\Developer { return $this->getCustomField(\Deploy\CustomFields\Developer::class); } // ... }

मुद्दा अनुरोध बनाएँ

जीरा में एक कार्य बनाना एक जटिल प्रक्रिया है। जब आप वेब इंटरफ़ेस के माध्यम से ऐसा करते हैं, तो आपको फ़ील्ड के सेट के साथ एक विशेष स्क्रीन (स्क्रीन बनाएँ) दिखाया जाता है। उनमें से कुछ आप केवल इसलिए भर सकते हैं क्योंकि आप चाहते हैं, और कुछ अनिवार्य के रूप में चिह्नित हैं। एक ही समय में, बनाएँ स्क्रीन प्रत्येक परियोजना के लिए और यहां तक कि एक परियोजना में विभिन्न प्रकार के कार्यों के लिए अद्वितीय हो सकती है। इसलिए क्षेत्र के मूल्यों और कार्य बनाने की प्रक्रिया में क्षेत्र मूल्य निर्धारित करने की बहुत संभावना पर सभी प्रकार के प्रतिबंध हैं।

इस स्थिति में डेवलपर्स के लिए सबसे अप्रिय बात यह है कि ये प्रतिबंध एपीआई पर लागू होते हैं। उत्तरार्द्ध में एक विशेष अनुरोध है (संस्करण 5.0 के बाद से REST API में उपलब्ध मेटा उपलब्ध है), जिसके साथ आप कार्य बनाते समय उपलब्ध फ़ील्ड सेटिंग्स की एक सूची प्राप्त कर सकते हैं। हालांकि, एक डेवलपर को "अभी एक साधारण काम करने की ज़रूरत है" जो सबसे अधिक संभावना है कि इससे परेशान नहीं होंगे।

नतीजतन, यह इस तरह से हुआ: चूंकि कार्य बनाने का अनुरोध काफी बड़ा हो सकता है, हमने अक्सर इसमें धीरे-धीरे डेटा जोड़ा, और जब हमने जीरा को सब कुछ भेजने की कोशिश की तो हमें एक त्रुटि मिली। उसके बाद, मुझे उन सभी स्थानों के लिए कोड में देखना पड़ा जहां अनुरोध में कुछ बदल गया, और यह समझने के लिए लंबे और कठिन प्रयास के लिए कि वास्तव में क्या गलत हुआ।

इसलिए, हमने \ Login \ Jira \ Issue \ CreateRequest किया । यह आपको पहले त्रुटि को देखने की अनुमति देता है, उस जगह पर जहां आप कुछ गलत करने की कोशिश कर रहे हैं: फ़ील्ड को किसी प्रकार का घुमावदार मान दें या उपलब्ध नहीं होने वाले फ़ील्ड को बदलें। उदाहरण के लिए, यदि आप एक घटक को निर्दिष्ट करने का प्रयास करते हैं जो परियोजना में मौजूद नहीं है, तो अपवाद उस स्थान पर दुर्घटनाग्रस्त हो जाएगा जहां आपने इसे किया था, और न कि जहां आपने अंततः एपीआई को अनुरोध भेजा था।

CreateRequest के साथ काम का प्रवाह कुछ इस तरह दिखता है

 $Request = new \Badoo\Jira\Issue\CreateRequest('DD', 'Task', $Client); $Request ->setSummary('summary') ->setDescription('description') ->setFieldValue('For QA', 'custom field with some comments for QA who will check the issue'); $Request->send();

सीधे एपीआई के साथ काम करें

ऊपर वर्णित कक्षाओं का सेट सबसे अधिक जरूरतों को कवर करता है। हालांकि, हम अच्छी तरह से जानते हैं कि बहुमत हर चीज से दूर है। इसलिए, हमारे पास सीधे API के साथ काम करने के लिए एक छोटा ग्राहक है - \ Badoo \ Jira \ REST \ Client ।

ग्राहक उपयोग मामला

 $Jira = \Badoo\Jira\REST\Client::instance(); $Jira->setJiraUrl('https://jira.example.com/'); $Jira->setAuth('user', 'password') $IssueInfo = $Jira->issue()->get('SMPL-1');

कस्टम क्षेत्रों के लिए कक्षा जनरेटर

कस्टम फ़ील्ड के साथ काम करना सुविधाजनक बनाने के लिए, प्रत्येक फ़ील्ड के पास कोड में अपनी कक्षा होनी चाहिए। हमने उन्हें आवश्यकतानुसार मैन्युअल रूप से स्वयं बनाया, लेकिन ग्राहक को प्रकाशित करने से पहले हमने फैसला किया कि यह दृष्टिकोण नए उपयोगकर्ताओं के लिए बहुत सुविधाजनक नहीं हो सकता है। इसलिए, हमने एक विशेष जनरेटर बनाया जो कस्टम फ़ील्ड की सूची के लिए जीरा एपीआई पर जा सकता है और ज्ञात फ़ील्ड प्रकारों के लिए टेम्पलेट कक्षाएं बना सकता है।

हम मानते हैं कि अधिकांश कार्यों के लिए यह हमारे रिपॉजिटरी से बिन / लिली का उपयोग करने के लिए पर्याप्त है। आप उनसे --help / -h विकल्प के माध्यम से अपने बारे में बताने के लिए कह सकते हैं:

 ./bin/generate --help

सरलतम स्थिति में, पीढ़ी के लिए यह आपके जीरा के URL को निर्दिष्ट करने के लिए पर्याप्त है, उपयोगकर्ता, उसका पासवर्ड, कक्षाओं के लिए नाम स्थान और कोड डालने के लिए निर्देशिका:

 ./bin/generate -u user -p password --jira-url https://jira.mlan --target-dir custom-fields --namespace CustomFields

हमने अपने स्वयं के टेम्प्लेट जोड़ने और व्यक्तिगत क्षेत्रों के लिए कक्षाएं उत्पन्न करने की क्षमता को भी लागू किया। यह प्रलेखन में पाया जा सकता है।

निष्कर्ष

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

हमारी राय में, यह एक अच्छी बात है, जो निश्चित रूप से यह समझना चाहिए कि क्या यह आपके कार्यों और आवश्यकताओं के अनुरूप है। हमारे तहत - बस फिट।

लिंक फिर से: github.com/badoo/jira-client

अंत तक पढ़ने के लिए धन्यवाद। हमें उम्मीद है कि यह कोड अब लाभान्वित करेगा और न केवल हमारे लिए समय बचाएगा।

बुश जीरा एपीआई क्लाइंट: पीएचपी में जीरा में जादू