Documentation

Utilisation

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

Le paramètre year est optionnel.
http://localhost:4000/cve?target=KEYWORD&year=YEAR

Exemples

http://localhost:4000/cve?target=ruby%20on%20rails
terminal browser

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

Si vous voulez analyser la dernière année, utilisez le mot-clé « latest ».
http://localhost:4000/cve?target=ruby%20on%20rails&year=latest

Pour commencer

Téléchargez le projet
bundle install
ruby rest.rb

Prérequis

Ruby
Docker (Optionnel, nécessaire uniquement si vous souhaitez l'exécuter via un conteneur.)

Environnement

Vous pouvez basculer entre prod et dev dans config/environment.rb
Vous devez en créer un vous-même, un exemple se trouve ici.

Vérification de santé

L'URL retournera un code d'état 200, ce qui signifie que l'API est saine.
Si 200 ne s'affiche pas, vous devez supposer qu'il y a un problème.
http://localhost:4000/status

Gérer l'image

Accès

Vous pouvez accéder à l'API via http://localhost:4000/
Vous devriez pouvoir voir la page d'index à partir de l'URL. index

Construire l'image

docker build . -t cve-api

Exécuter l'image

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

Obtenir l'ID

docker ps

Arrêter l'image

docker stop ID

Supprimer l'image

docker rmi cve-api

Cve-api

Populaires