swagger-stats

(β˜… 937)

API Observability. Trace API calls and Monitor API performance, health and usage statistics in Node.js Microservices.

  • .editorconfig
  • .gitignore
  • .npmignore
  • .travis.yml
  • CHANGELOG.md
  • CONTRIBUTING.md
  • LICENSE
  • package-lock.json
  • package.json
  • README.md

# Installation Guide

1. Get the code
git clone https://github.com/slanatech/swagger-stats

Downloads the entire project code from GitHub to your computer.

cd swagger-stats

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
docker compose -f scripts/elasticsearch/elastic5/docker-compose.yml up -d --build

Runs the command against the services defined in the compose file.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install swagger-stats --save

Downloads and installs the libraries listed in package.json.

npm install prom-client@12 --save

Downloads and installs the libraries listed in package.json.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation