आरईएसटी के साथ हम अपने एपीआई को दस्तावेज करने और एचटीएमएल दस्तावेज जेनरेट करने के लिए स्वैगर, आरएएमएल या अन्य तकनीकों का उपयोग कर सकते हैं जो हमारे उपभोक्ता सर्वर के साथ बातचीत की आवश्यकता के बिना पढ़ सकते हैं।एक ग्राफक्लुएल एपीआई
क्या कुछ समान ग्राफिकल के लिए मौजूद है? संसाधनों और संपत्तियों के दस्तावेज उत्पन्न करने का कोई तरीका है?
ऐसा लगता है जैसे अब https://www.npmjs.com/package/graphql-docs
ग्राफिकल स्कीमा के लिए गतिशील रूप से जेनरेट किए गए दस्तावेज़ एक्सप्लोरर। इसका उद्देश्य ग्राफिक्यूएल की तुलना में एक स्कीमा का बेहतर अवलोकन प्रदान करना है, लेकिन बिना पूछताछ के।
तुम भी एक स्कीमा फ़ाइल या GraphQL endpoint आधार पर एक स्थिर प्रलेखन फाइल उत्पन्न कर सकते हैं:
npm install -g graphql-docs
graphql-docs-gen http://GRAPHQL_ENDPOINT documentation.html
मेरी जानकारी के लिए वहाँ अभी तक कि स्वचालित रूप से कोई उपकरण है एक GraphQL एपीआई के लिए HTML प्रलेखन उत्पन्न करता है, लेकिन मैं GraphiQL पाया है HTML में किसी भी API दस्तावेज़ है कि मैंने देखा है की तुलना में और भी अधिक उपयोगी हो सकता है।
GraphiQL आपको एक ग्राफ़क्यूएल सर्वर की स्कीमा को इंटरैक्टिव रूप से एक्सप्लोर करने और एक ही समय में इसके खिलाफ क्वेरी चलाने देता है। इसमें वाक्यविन्यास हाइलाइटिंग, स्वत: पूर्णता है, और यह आपको तब भी बताता है जब आपकी क्वेरी निष्पादित किए बिना अमान्य है।
यदि आप स्थिर दस्तावेज की तलाश में हैं, तो मुझे ग्राफक्ल्यू स्कीमा भाषा में स्कीमा पढ़ने के लिए यह बहुत सुविधाजनक लगता है। ग्राफ़क्यूएल की एक और महान विशेषता के लिए धन्यवाद - स्कीमा आत्मनिरीक्षण - आप आसानी से किसी भी सर्वर के लिए स्कीमा प्रिंट कर सकते हैं। सीधे शब्दों में सर्वर के विरुद्ध introspection query चलाने के लिए और उसके बाद तो जैसे जिसके परिणामस्वरूप आत्मनिरीक्षण स्कीमा प्रिंट (का उपयोग कर graphql-js):
var graphql = require('graphql');
var introspectionSchema = {}; // paste schema here
console.log(graphql.printSchema(graphql.buildClientSchema(introspectionSchema)));
परिणाम कुछ इस तरह दिखेगा:
# An author
type Author {
id: ID!
# First and last name of the author
name: String
}
# The schema's root query type
type Query {
# Find an author by name (must match exactly)
author(name: String!): Author
}
मैं GraphQL स्कीमा का दस्तावेजीकरण के लिए स्टेटिक पेज जनरेटर पाया। ।
एचटीएमएल निर्यात इस तरह दिखता है।
धन्यवाद, Helfer। एपीआई का उपयोग दस्तावेज के रूप में करने की चेतावनी यह है कि कभी-कभी डेवलपर को पहुंचने से पहले इसकी आवश्यकता होती है। उदाहरण के लिए: कुछ एपीआई सेवा खरीदने का फैसला करते समय। आपने इस चेतावनी के लिए एक अच्छा विकल्प प्रदान किया है। उपयोगी उत्तर के लिए धन्यवाद। मैं थोड़ी देर इंतजार करूंगा और अगर कोई बेहतर न आए तो इसे स्वीकार कर लिया जाएगा। –