Home

Getting Started

Overview

The overall system could look like this

where

• the box apis-catalog refers to https://github.com/omallassi/apis-catalog. This project provides a REST Backend Server (./server) and a CLI (./cli)
• the box apis-catalog-web refers to https://github.com/omallassi/apis-catalog-web. This project provides an optional Web UI based on the REST Backend.

Installation

Refer to this page for installation steps.

Build w/ Docker

Refer to this page.

Usage

Available Statistics

Refer to this page to get a list of available statistics and their definitions. Note that metrics are accessible only via Web UI and should be refreshed on a regular basis.

• To refresh metrics, simply call url -v -X POST http://mx24996vm:8080/v1/metrics/refresh
• check Installation to see how to schedule the above REST call (using crontab or...)

Create your domains

TBD Refer to CLI Overview or Web UI Overview

Create your layers

TBD Refer to CLI Overview

Create your APIs

TBD Refer to CLI Overview

Conceptual Model

Refer to Conceptual model for more details

REST APIs Overview

Refer to REST APIs for more details.