Skip to content

README.md

Latest commit

 

History

History
97 lines (58 loc) · 3.02 KB

README.md

File metadata and controls

97 lines (58 loc) · 3.02 KB

Unprotected Server Example

The unprotected example is the base reference to build the Approov protected servers. This a very basic Hello World server.

TOC - Table of Contents

Why?

To be the starting building block for the Approov protected servers, that will show you how to lock down your API server to your mobile app. Please read the brief summary in the Approov Overview at the root of this repo or visit our website for more details.

TOC

How it works?

The Java Spring API server is very simple and only replies to the endpoint / with the message:

{"message": "Hello, World!"}

You can find the endpoint definition here.

TOC

Requirements

To run this example you will need to have installed:

  • OpenJDK - This server example uses version 11.0.3. It should work with earlier or later versions but was not tested.
  • Java Spring - Version 2.6.4 of the Spring Framework plugin is being used. The code should work with prior versions but wasn't tested.

TOC

Try It

First build the server with gradle. From the ./servers/hello/src/unprotected-server folder execute:

./gradlew build

Now, you can run this example from the ./servers/hello/src/unprotected-server folder with:

set -a  # auto-export all assignments
source .env && ./gradlew bootRun
set +a  # stop exporting variables

Finally, you can test that it works with:

curl -X GET 'http://localhost:8002'

The response will be:

{"message":"Hello, World!"}

TOC

Issues

If you find any issue while following our instructions then just report it here, with the steps to reproduce it, and we will sort it out and/or guide you to the correct path.

TOC

Useful Links

If you wish to explore the Approov solution in more depth, then why not try one of the following links as a jumping off point:

TOC