Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gravitee-io/gravitee-management-rest-api

Gravitee.io - API Management - Management Rest API
https://github.com/gravitee-io/gravitee-management-rest-api

Last synced: 4 months ago
JSON representation

Gravitee.io - API Management - Management Rest API

Awesome Lists containing this project

README

        

= Gravitee Management REST API

⚠️ DEPRECATED
This repository is no longer active, all the sources have been moved to a new monorepo: link:https://github.com/gravitee-io/gravitee-api-management[Gravitee.io API Management]

The new repository will be become the single GitHub repository for everything related to Gravitee.io API Management.

== Overview

A restful API providing a bunch of services to manage and configure the global platform.
All exposed services are constraint by authentication and authorization rules.

== Documentation

You can find Gravitee.io API Management documentation from https://docs.gravitee.io/[Gravitee.io website].

== Building

[source]
----
$ git clone https://github.com/gravitee-io/gravitee-management-rest-api
$ cd gravitee-management-rest-api
$ mvn clean compile exec:java -Pdev -pl gravitee-rest-api-standalone/gravitee-rest-api-standalone-container
...

----

== Makefile support

You can use link:Makefile[Makefile] to set up an environment locally and run `Postman` tests against it.

Run `make` or `make --help` to see the list of available commands.

=== Build and start your environment

`make gravitee`

The version will be based on your current branch's link:pom.xml[pom.xml]

If containers exists, they will be stopped and deleted.

You can skip tests running `make gravitee OPTIONS=-DskipTests`

=== Start or stop the environment

`make start`

`make stop`

=== Reset the environment

`make reset`

Stop the containers, delete data on databases and start the containers

=== Run Postman tests

Your environment need to be up. A message will be prompted if it is not the case.

`make postman` will run postman collections on localhost.

You can specify `nightly` or `demo` parameters to choose where to run collections.

`make postman env=nightly`

`make postman env=demo`

=== Insert bulk of data

Your environment need to be up. A message will be prompted if it is not the case.

`make bulk` will insert 100 Applications and 100 Apis on localhost.