Quick start

1. Download and unpack the binaries

The JDK and JRE are included in binaries, so they don't needed to be installed additionally.

2. Start the IDE

Execute start.cmd on Windows or start.sh on Linux.

3. Create new project

Using top menu select Project / Create new project, enter the project name myapp and click Ok.

4. Add new Service

Press the + button on Toolbar, select service Test and click Ok. This service will be used to return the HTTP response body. As the text, you can input Hello from my first API! and click Save button.

5. Add new API operation

Open the context menu on "API/GET" node on project tree by right-click. Then select "Add operation". In field "pattern" input hello and in field "Service" select previously added text service. Then switch to "On send response" tab and drag-and-drop "serviceOutput(STRING)" to "body(BINARY)", so the mapping from the text service output to http response is created. Expand "header" node on the outgoing response and double-click on "content-type". Enter 'text/plain' (in single quotes) and click Ok. So you set the response content type to 'text/plain'. Click "Save and close".

6. Build and start the application

Click on first button in the Toolbar "Build...", it will open the "Build / Run" tab. Click "Build app" button, it will build the standalone application (and the .war file). Then click the "Start app" to start the application.

7. Test the API

If the application is started without errors, your fresh API operation should be available in web browser under "http://localhost:8080/myapp/hello".

Troubleshooting

If the IDE doesn't start, you can adapt the start script in order to get more information:

replace
start %JAVA_HOME%\bin\javaw
with:
%JAVA_HOME%\bin\java

Copyright © 2024, Anton Savchenko. All rights reserved. E-Mail: feedback@calium.org