पायथन और फ्लास्क के साथ RESTful API बनाना

RESTful API (रिप्रेजेंटेशनल स्टेट ट्रांसफर) नेटवर्क अनुप्रयोगों को डिजाइन करने के लिए एक लोकप्रिय आर्किटेक्चरल स्टाइल है। वे मानक HTTP विधियों का उपयोग करते हैं और आमतौर पर स्केलेबल और स्टेटलेस वेब सेवाएँ बनाने के लिए नियोजित होते हैं। फ्लास्क एक हल्का पायथन वेब फ्रेमवर्क है जो अपनी सादगी और लचीलेपन के कारण RESTful API विकसित करने के लिए आदर्श है।

अपना फ्लास्क वातावरण सेट अप करना

RESTful API बनाने से पहले, आपको अपना Flask वातावरण सेट करना होगा। आप इसे इस तरह से कर सकते हैं:

पाइप का उपयोग करके फ्लास्क स्थापित करें:

pip install flask

एक बार फ्लास्क स्थापित हो जाने पर, आप अपना एपीआई विकसित करना शुरू कर सकते हैं।

एक सरल फ्लास्क एपीआई बनाना

आइए एक सरल RESTful API बनाएं जो बुनियादी CRUD (क्रिएट, रीड, अपडेट, डिलीट) ऑपरेशन कर सके। यहाँ एक बुनियादी उदाहरण दिया गया है:

from flask import Flask, jsonify, request

app = Flask(__name__)

# Sample data
tasks = [
    {'id': 1, 'title': 'Buy groceries', 'done': False},
    {'id': 2, 'title': 'Walk the dog', 'done': True}
]

@app.route('/tasks', methods=['GET'])
def get_tasks():
    return jsonify({'tasks': tasks})

@app.route('/tasks/', methods=['GET'])
def get_task(task_id):
    task = next((task for task in tasks if task['id'] == task_id), None)
    if task is None:
        return jsonify({'error': 'Task not found'}), 404
    return jsonify({'task': task})

@app.route('/tasks', methods=['POST'])
def create_task():
    new_task = request.get_json()
    tasks.append(new_task)
    return jsonify({'task': new_task}), 201

@app.route('/tasks/', methods=['PUT'])
def update_task(task_id):
    task = next((task for task in tasks if task['id'] == task_id), None)
    if task is None:
        return jsonify({'error': 'Task not found'}), 404
    data = request.get_json()
    task.update(data)
    return jsonify({'task': task})

@app.route('/tasks/', methods=['DELETE'])
def delete_task(task_id):
    global tasks
    tasks = [task for task in tasks if task['id'] != task_id]
    return jsonify({'result': 'Task deleted'})

if __name__ == '__main__':
    app.run(debug=True)

इस उदाहरण में:

/tasks (GET) सभी कार्यों की सूची लौटाता है।
/tasks/<task_id> (GET) किसी विशिष्ट कार्य को उसकी ID के आधार पर लौटाता है।
/tasks (POST) एक नया कार्य बनाता है.
/tasks/<task_id> (PUT) किसी मौजूदा कार्य को उसकी ID के आधार पर अद्यतन करता है।
/tasks/<task_id> (DELETE) किसी कार्य को उसकी ID के आधार पर हटाता है।

अपने API का परीक्षण करें

अपने फ्लास्क एपीआई का परीक्षण करने के लिए, आप Postman जैसे टूल या curl जैसे कमांड-लाइन टूल का उपयोग कर सकते हैं। उदाहरण के लिए, कार्यों को पुनः प्राप्त करने के लिए GET एंडपॉइंट का परीक्षण करने के लिए, आप इसका उपयोग कर सकते हैं:

curl http://localhost:5000/tasks

त्रुटियों और अपवादों से निपटना

मजबूत API के लिए उचित त्रुटि प्रबंधन महत्वपूर्ण है। फ्लास्क में, आप कस्टम त्रुटि हैंडलर परिभाषित करके त्रुटियों को संभाल सकते हैं। उदाहरण के लिए, आप 404 त्रुटियों को इस तरह से संभाल सकते हैं:

@app.errorhandler(404)
def not_found_error(error):
    return jsonify({'error': 'Not found'}), 404

निष्कर्ष

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

पायथन फ्लास्क एपीआई रेस्टफुल एंडपॉइंट्स क्रूड http JSON अनुरोध डेटा त्रुटियाँ सर्वर वेब विकास