https://github.com/simplicitesoftware/module-demo-apis

Custom APIs for the Simplicité demo application
https://github.com/simplicitesoftware/module-demo-apis

Last synced: about 14 hours ago
JSON representation

Custom APIs for the Simplicité demo application

• Host: GitHub
• URL: https://github.com/simplicitesoftware/module-demo-apis
• Owner: simplicitesoftware
• Created: 2020-12-08T11:13:42.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2024-10-30T22:57:31.000Z (8 days ago)
• Last Synced: 2024-10-30T23:27:50.427Z (8 days ago)
• Language: Java
• Size: 79.1 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        

![](https://docs.simplicite.io//logos/logo250.png)

* * *

`DemoAPIs` module definition

============================

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=simplicite-modules-DemoProject&metric=alert_status)](https://sonarcloud.io/dashboard?id=simplicite-modules-DemoProject)

### Introduction

This module contains the following custom APIs for the demo **order management** application.:

- A standard mapped API for various business object

- A custom API for the product business object

### Prerequisites

The `Demo` module **must** be installed and configured before importing this addon module.

### Import

To import this module:

- Create a module named `DemoAddons`

- Set the settings as:

```json

{

	"type": "git",

	"origin": {

		"uri": "https://github.com/simplicitesoftware/module-demo-apis.git"

	}

}

```

- Click on the _Import module_ button

### Configure

Custom URIs can be configured in the `URI_MAPPINGS` system parameter:

```json

[

	(...)

	{ "source": "^/demo/api/v1(.+)$", "destination": "/api/ext/DemoAPI1$1" },

	{ "source": "^/demo/api/v2(.+)$", "destination": "/api/ext/DemoAPI2$1" },

	(...)

]

```

`DemoAPI1` external object definition

-------------------------------------

Custom REST web services

`DemoAPI2` external object definition

-------------------------------------

Custom REST web services