[8.5.5.8 or later]

Publishing a REST API definition file

You can deploy a web project to a Liberty server. You can view the published application programming interface (API) definition file in a web browser.

Before you begin

Specify your REST API by creating a swagger.json file. For more information about creating a swagger.json file, see Creating a REST API definition file.

About this task

Important: Applicable to Liberty, Liberty Core

Procedure

  1. Configure the server.xml file to enable the runtime environment to look for the swagger.json file.

    For more information about configuring the server.xml file, see Discovering REST API documentation on a Liberty server.

  2. Start the Liberty server.

    For more information about starting a Liberty server, see Starting and stopping a server by using developer tools.

  3. In the Servers view, right-click on the Liberty server and select Add and Remove.
  4. Select your web project, click Add, and then click Finish.
  5. To view the REST API document, open a browser window and go to https://host:https_port/ibm/api/explorer.
Icon that indicates the type of topic Task topic
Timestamp icon Last updated: July 17, 2017 21:58

File name: t_restapi_publish.html