2014-04-30 9 views
12

मैं इस सामान के लिए नया हूं लेकिन मुझे यह पसंद है। मैंने स्लिम फ्रेमवर्क का उपयोग करके थोड़ा आरईएसटी एपी बनाया। अब मैं इसके बारे में एक सतत दस्तावेज रखना चाहता हूं। मुझे लगता है कि swagger सही विकल्प है, लेकिन मुझे अभी तक यह पता नहीं चला है कि इसे कैसे एकीकृत किया जाए?SLIM और SWAGGER का उपयोग कर विश्वसनीय API दस्तावेज़?

चीयर्स आपके धैर्य :)

+0

मैंने स्वैगर के बारे में अच्छी बात सुनी है - क्या संबंधित वेबसाइट पर कोई दस्तावेज़ हैं? हालांकि, मेरा अनुमान है कि यह विषय यहां बहुत व्यापक है - ध्यान रखें कि स्टैक ओवरफ़्लो कोडिंग प्रोग्रामिंग समस्याओं के लिए है। यदि आप इसे जाने और इस सवाल को _what_ के बारे में संपादित कर सकते हैं, तो आप बहुत अच्छे होंगे। – halfer

+0

मुझे नहीं पता कि मेरे PHP प्रोजेक्ट में swagger को एकीकृत कैसे करें। वे जीथ्यूब पर एक PHP क्लाइंट और जावा के लिए एक सर्वर एकीकरण ट्यूटोरियल प्रदान करते हैं लेकिन इससे मुझे आगे नहीं ले गया। फिलहाल मुझे नहीं पता कि मुझे कौन से कदम उठाने हैं। मैं अपने स्रोत में टिप्पणियां नहीं डालना चाहता हूं और फिर एक उपकरण चलाता हूं जो एक दस्तावेज़ीकरण बनाता है। – user2942586

उत्तर

17

के लिए & धन्यवाद मुझे लगता है कि आप इस परियोजना के लिए देख रहे हैं: zircote/swagger-php

Here आप कैसे एक यूआरएल के लिए उपयोगकर्ता अनुरोध पर डॉक उत्पन्न करने के लिए मिल जाएगा।

मूल रूप से आप एक कोड इस के समान के साथ स्लिम में एक और मार्ग बनाने, स्वैगर एनोटेशन के साथ अपने कोड पर टिप्पणी करने के लिए है:

<?php 
use Swagger\Swagger; 
$swagger = new Swagger('/project/root/top_level'); 
header("Content-Type: application/json") 
echo $swagger->getResource('/pet', array('output' => 'json')); 

और यह आप के लिए उड़ान भरने पर स्वैगर एपीआई डॉक्स उत्पन्न होगा।

+0

धन्यवाद! लेकिन मैं इसके साथ swagger-UI को कैसे एकीकृत करूं? – user2942586

+0

इसे मिला और चला रहा है :) – user2942586

+0

@ user2942586 क्या आप यह समझाने के लिए बहुत दयालु होंगे कि आप इसे कैसे प्राप्त करते हैं और चल रहे हैं? – LeonardChallis

संबंधित मुद्दे