डॉक्स·OpenAPI और Postman
⚙

OpenAPI और Postman

लाइव OpenAPI spec, Scalar viewer, Postman collection — क्लाइंट जनरेट करें, mock servers, और बहुत कुछ।

OpenAPI spec

विहित OpenAPI 3.1 spec यहाँ लाइव परोसा जाता है:

https://api.eveses.com/docs/openapi.yaml

यह प्रत्येक डिप्लॉय पर वास्तविक route handlers से पुन: उत्पन्न होता है, इसलिए यह कभी भी production व्यवहार से नहीं हटता। इसका उपयोग करें:

  • किसी भी भाषा में क्लाइंट जनरेट करें (openapi-generator-cli generate -i openapi.yaml -g python)
  • एक mock server चालू करें (prism mock openapi.yaml)
  • CI में अपनी अंतिम vendored कॉपी के साथ diff करें

ब्राउज़ करें

Scalar viewer spec को इंटरैक्टिव डॉक्स के रूप में यहाँ रेंडर करता है:

https://api.eveses.com/docs

auth बॉक्स में अपनी API कुंजी पेस्ट करके सीधे ब्राउज़र में endpoints आज़माएँ।

Postman

संग्रह आयात करें (उसी spec से उत्पन्न):

https://api.eveses.com/docs/eveses.postman_collection.json

यह env चर eveses_api_key और eveses_base_url के साथ आता है। उन्हें एक बार सेट करें, सभी अनुरोध पूर्व-भरे हुए हैं।

संस्करण

वर्तमान spec v1 है। हम कभी भी v1 endpoints नहीं तोड़ते — जोड़ backward-compatible हैं। एक भविष्य की v2 deprecation से पहले कम से कम 12 महीने v1 के साथ रहेगी।

जोड़ की सूचना के लिए /changelog/api की सदस्यता लें।