इस पेज पर Google Docs के सीज़न के लिए स्वीकार किए गए एक तकनीकी लेखन प्रोजेक्ट की जानकारी है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- जोड़ना
- तकनीकी लेखक:
- लॉरेल्म
- प्रोजेक्ट का नाम:
- REST API का दस्तावेज़
- प्रोजेक्ट की अवधि:
- मानक अवधि (तीन महीने)
प्रोजेक्ट का विवरण
Ensembl REST API का इस्तेमाल करने के लिए, डेवलपर के इस्तेमाल के लिए गाइड को बेहतर बनाएं
मुख्य फ़ोकस -- ज़्यादा उपयोगकर्ता के लिए आसान परिचय/शुरुआत करना सेक्शन दें.
लागू करने का सुझाव, इन दस्तावेज़ पेजों की लाइनों के मुताबिक होता है:
https://developers.google.com/maps/documentation/maps-static/intro
https://developers.google.com/maps/documentation/maps-static/dev-guide
मुख्य पेज:
इसमें ये सेक्शन शामिल हैं (हाई लेवल व्यू):
इस एपीआई के इस्तेमाल से जुड़ी खास जानकारी
REST के बारे में कम शब्दों में जानकारी
छोटा सा उदाहरण
पुष्टि करने की जानकारी
अलग-अलग एचटीटीपी तरीकों का इस्तेमाल करके, यूआरएल बनाने के तरीके के बारे में जानकारी
ज़रूरी और वैकल्पिक पैरामीटर के बारे में जानकारी. साथ ही, यह जानकारी कि एंडपॉइंट अपने-आप जनरेट होने वाले दस्तावेज़ में कहां मौजूद होते हैं.
इस ट्रेनिंग पेज का लिंक: https://www.ebi.ac.uk/training/online/course/ensembl-rest-api
ट्रेनिंग कोर्स में इस्तेमाल किए जाने वाले हेल्पर_फ़ंक्शन के बारे में जानकारी
बाद के पेज
मुख्य पेज में दिए गए विषयों की जटिलता के आधार पर, कुछ विषयों को बाद के ज़्यादा जानकारी वाले पेजों से लिंक करना पड़ सकता है.