Generate and Run Your REST API

1. Validate the configurations by pressing the "Validate" button on the AlchemyJ toolbar.

2. You need to fix all the errors before building the project or the program would not run properly. You can ignore the warnings if you know how they would affect the result. You can click the link on column B of the Validation sheet to go to the specific cell mentioned.

   

3. Click Generate API from the AlchemyJ toolbar. After AlchemyJ builds the project, it will run the REST API in a testing server. If the server does not start automatically, please check the option "Start server when finished" on the "API Generation" tab of the Properties window.

   

   

   

4. As you can see, the server is started successfully.

   

5. Now, you can try to call your REST API from OpenAPI UI.

a. Open a browser, type the OpenAPI UI URL http://localhost:8080/openapi/index.html

b. Expand the '/endpointGroup/resource1' section, click 'Try it out" button

c. Input the value in the 'input_parameter_1' input box.

d. Click "Execute" button and the REST API endpoint call shall be responsed.

Please note that only REST APIs support the "Start server when finished" option. The Source Type must be JAR file. To test a WAR package, you need to deploy the WAR file to an application server.

For Java API, you can test the API by using AlchemyJ testing tool. For more details, please refer to Testing Tool.