Employee Lookup Process API - Implementation Template
home
This template serves as a foundation for API Led Connectivity approach of running an enterprise.
The template is a Process API for saving information about Ids from different systems.
This template is a REST API implemented using APIkit and RAML definition. The API uses JSON as an exchange format. Included are example requests and responses.
Below are the endpoints that are implemented.
GET /employees/{id}
Retrieves employee from ObjectStore based on id
POST /employees
Inserts new employee (Ids) to ObjectStore
Look at the included self-descriptive RAML definition and the corresponding flows to learn more about the flows.
License Agreement
This template is subject to the conditions of the MuleSoft License Agreement. Review the terms of the license before downloading and using this template. You can use this template for free with the Mule Enterprise Edition, CloudHub, or as a trial in Anypoint Studio.
Run it!
Simple steps to get API Led Connectivity Process API for running.
Running on premise
In this section we detail the way you should run your template on your computer.
Where to Download Mule Studio and Mule ESB
First thing to know if you are a newcomer to Mule is where to get the tools.
Importing a template into Studio
Mule Studio offers several ways to import a project into the workspace, for instance:
- Anypoint Studio generated Deployable Archive (.jar)
- Anypoint Studio Project from External Location
You can find a detailed description on how to do so in this Documentation Page.
Running on Studio
Once you have imported you template into Anypoint Studio you need to follow these steps to run it:
- Locate the properties file
mule.dev.properties
, in src/main/resources - Complete all the properties required as per the examples in the section Properties to be configured
- Once that is done, right click on you template project folder
- Hover you mouse over
"Run as"
- Click on
"Mule Application"
Running on Mule ESB stand alone
Complete all properties in one of the property files, for example in mule.prod.properties and run your app with the corresponding environment variable to use it. To follow the example, this will be mule.env=prod
.
Running on CloudHub
While creating your application on CloudHub (Or you can do it later as a next step), you need to go to Deployment > Advanced to set all environment variables detailed in Properties to be configured as well as the mule.env.
Deploying your template on CloudHub
Mule Studio provides you with really easy way to deploy your Template directly to CloudHub, for the specific steps to do so please check this link
Properties to be configured (With examples)
In order to use this Mule template you need to configure properties (Credentials, configurations, etc.) either in properties file or in CloudHub as Environment Variables. Detail list with examples:
Application configuration
Common Configuration
- http.port
9090
- api.domain
localhost