प्रोजेक्ट इकट्ठा करें

इस पेज में एक तकनीकी लेखन प्रोजेक्ट की जानकारी है, जिसे दस्तावेज़ के Google सीज़न के लिए स्वीकार किया जाता है.

प्रोजेक्ट की खास जानकारी

ओपन सोर्स संगठन:
Ensembl
टेक्निकल राइटर:
laurelm
प्रोजेक्ट का नाम:
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

  • ट्रेनिंग कोर्स में इस्तेमाल किए जाने वाले helper_Functions के बारे में जानकारी

बाद के पेज

मुख्य पेज पर दिए गए विषयों की जटिलता के आधार पर, कुछ विषयों को ज़्यादा जानकारी वाले पेजों से लिंक करना पड़ सकता है.