Skip to content

A simple project which exposes RESTful APIs to generate, validate the Invite tokens

Notifications You must be signed in to change notification settings

charmLd/token-generator-api

Repository files navigation

Token Generator API

This microservice is exposing RESTful APIs to generate,validate,visualize invite tokens

API Documentation

API documentation can be found in ./doc/api/openapi.yaml.

Use Swagger Editor to view the file.

Database Script

This use a mysql database and the script can be found in ./database-script/auth_db.sql .

Code Quality Check

SonarQube is used for checking code quality. Much of the needed sonarqube configurations are in the sonar-project.properties file.

To run the code quality check sonar-scanner is needed. Download sonar-scanner from here.

Also an authentication key is needed to access the SonarQube web service. Follow these instructions to setup an authentication key.

Use following command to run code quality check.

/<path-to-sonar-scanner-location-in-filesystem>/bin/sonar-scanner \
  -Dsonar.login=<authentication-key>

About

A simple project which exposes RESTful APIs to generate, validate the Invite tokens

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages