दस्तावेज़

उपयोग

http://localhost:4000/cve?target=KEYWORD

वर्ष पैरामीटर वैकल्पिक है।
http://localhost:4000/cve?target=KEYWORD&year=YEAR

उदाहरण

http://localhost:4000/cve?target=ruby%20on%20rails
टर्मिनल ब्राउज़र

http://localhost:4000/cve?target=ruby%20on%20rails&year=2020

यदि आप नवीनतम वर्ष को पार्स करना चाहते हैं, तो "latest" कीवर्ड का उपयोग करें।
http://localhost:4000/cve?target=ruby%20on%20rails&year=latest

शुरू करना

प्रोजेक्ट डाउनलोड करें
bundle install
ruby rest.rb

आवश्यकताएँ

Ruby
Docker (वैकल्पिक, केवल तब आवश्यक जब आप कंटेनर के माध्यम से चलाना चाहते हैं।)

पर्यावरण

आप config/environment.rb पर prod और dev के बीच स्विच कर सकते हैं।
आपको स्वयं एक बनाने की आवश्यकता है, एक उदाहरण यहाँ पाया जा सकता है।

स्वास्थ्य जाँच

URL एक 200 स्थिति कोड लौटाएगा जो दर्शाता है कि API स्वस्थ है।
यदि 200 नहीं दिखाया गया है तो आपको मान लेना चाहिए कि कुछ गड़बड़ है।
http://localhost:4000/status

छवि प्रबंधित करें

पहुँच

आप API तक http://localhost:4000/ के माध्यम से पहुँच सकते हैं।
आप URL से इंडेक्स पेज देख पाएंगे।

छवि बनाएँ

docker build . -t cve-api

छवि चलाएँ

docker run -p 4000:4000 -d cve-api

आईडी प्राप्त करें

docker ps

छवि रोकें

docker stop ID

छवि हटाएँ

docker rmi cve-api

Cve-api

सबसे लोकप्रिय