Documenting RESTful APIs

duration 20 minutes

Prerequisites:

Explore how to document and filter RESTful APIs from code or static files by using MicroProfile OpenAPI.

What you’ll learn

You will learn how to document and filter RESTful APIs from annotations, POJOs, and static OpenAPI files by using MicroProfile OpenAPI.

The OpenAPI specification, previously known as the Swagger specification, defines a standard interface for documenting and exposing RESTful APIs. This specification allows both humans and computers to understand or process the functionalities of services without requiring direct access to underlying source code or documentation. The MicroProfile OpenAPI specification provides a set of Java interfaces and programming models that allow Java developers to natively produce OpenAPI v3 documents from their JAX-RS applications.

You will document the RESTful APIs of the provided inventory service, which serves two endpoints, inventory/systems and inventory/properties. These two endpoints function the same way as in the other MicroProfile guides.

Before you proceed, note that the 1.0 version of the MicroProfile OpenAPI specification does not define how the /openapi endpoint may be partitioned in the event of multiple JAX-RS applications running on the same server. In other words, you must stick to one JAX-RS application per server instance as the behaviour for handling multiple applications is currently undefined.

Getting started

The fastest way to work through this guide is to clone the Git repository and use the projects that are provided inside:

git clone https://github.com/openliberty/guide-microprofile-openapi.git
cd guide-microprofile-openapi

The start directory contains the starting project that you will build upon.

The finish directory contains the finished project that you will build.

Before you begin, make sure you have all the necessary prerequisites.

Try what you’ll build

The finish directory in the root of this guide contains the finished application. Give it a try before you proceed.

To try out the application, first go to the finish directory and run the following Maven goal to build the application and deploy it to Open Liberty:

cd finish
mvn liberty:run

After you see the following message, your application server is ready:

The defaultServer server is ready to run a smarter planet.

Next, point your browser to the http://localhost:9080/openapi URL and you’ll see the RESTful APIs of the inventory service. You can also point to the http://localhost:9080/openapi/ui URL for a more interactive view of the deployed APIs. This UI is built from the Open Source Swagger UI and renders the generated /openapi document into a very user friendly page.

After you are finished checking out the application, stop the Open Liberty server by pressing CTRL+C in the command-line session where you ran the server. Alternatively, you can run the liberty:stop goal from the finish directory in another shell session:

mvn liberty:stop

Generating the OpenAPI document for the inventory service

You can generate an OpenAPI document in various ways. First, because all Jakarta Restful Web Services annotations are processed by default, you can augment your existing Jakarta Restful Web Services annotations with OpenAPI annotations to enrich your APIs with a minimal amount of work. Second, you can use a set of predefined models to manually create all elements of the OpenAPI tree. Finally, you can filter various elements of the OpenAPI tree, changing them to your liking or removing them entirely.

Navigate to the start directory to begin.

When you run Open Liberty in development mode, known as dev mode, the server listens for file changes and automatically recompiles and deploys your updates whenever you save a new change. Run the following goal to start Open Liberty in dev mode:

mvn liberty:dev

After you see the following message, your application server in dev mode is ready:

**************************************************************
*    Liberty is running in dev mode.

Dev mode holds your command-line session to listen for file changes. Open another command-line session to continue, or open the project in your editor.

Because the Jakarta Restful Web Services framework handles basic API generation for Jakarta Restful Web Services annotations, a skeleton OpenAPI tree will be generated from the inventory service. You can use this tree as a starting point and augment it with annotations and code to produce a complete OpenAPI document.

Now, visit the http://localhost:9080/openapi URL to see the generated OpenAPI tree. You can also visit the http://localhost:9080/openapi/ui URL for a more interactive view of the APIs.

Augmenting the existing Jakarta Restful Web Services annotations with OpenAPI annotations

Because all Jakarta Restful Web Services annotations are processed by default, you can augment the existing code with OpenAPI annotations without needing to rewrite portions of the OpenAPI document that are already covered by the Jakarta Restful Web Services framework.

Update the InventoryResource class.
src/main/java/io/openliberty/guides/inventory/InventoryResource.java

Add OpenAPI @APIResponse, @APIResponseSchema, @Operation, and @Parameter annotations to the two JAX-RS endpoint methods, getPropertiesForHost() and listContents().

InventoryResource.java

  1// tag::copyright[]
  2/*******************************************************************************
  3 * Copyright (c) 2017, 2022 IBM Corporation and others.
  4 * All rights reserved. This program and the accompanying materials
  5 * are made available under the terms of the Eclipse Public License v1.0
  6 * which accompanies this distribution, and is available at
  7 * http://www.eclipse.org/legal/epl-v10.html
  8 *
  9 * Contributors:
 10 *     IBM Corporation - Initial implementation
 11 *******************************************************************************/
 12// end::copyright[]
 13package io.openliberty.guides.inventory;
 14
 15import java.util.Properties;
 16import jakarta.enterprise.context.RequestScoped;
 17import jakarta.inject.Inject;
 18import jakarta.ws.rs.GET;
 19import jakarta.ws.rs.Path;
 20import jakarta.ws.rs.PathParam;
 21import jakarta.ws.rs.Produces;
 22import jakarta.ws.rs.core.MediaType;
 23import jakarta.ws.rs.core.Response;
 24
 25import org.eclipse.microprofile.openapi.annotations.Operation;
 26import org.eclipse.microprofile.openapi.annotations.enums.SchemaType;
 27import org.eclipse.microprofile.openapi.annotations.media.Content;
 28import org.eclipse.microprofile.openapi.annotations.media.Schema;
 29import org.eclipse.microprofile.openapi.annotations.parameters.Parameter;
 30import org.eclipse.microprofile.openapi.annotations.responses.APIResponse;
 31import org.eclipse.microprofile.openapi.annotations.responses.APIResponseSchema;
 32import io.openliberty.guides.inventory.model.InventoryList;
 33
 34@RequestScoped
 35@Path("/systems")
 36public class InventoryResource {
 37
 38    @Inject
 39    InventoryManager manager;
 40
 41    @GET
 42    @Path("/{hostname}")
 43    @Produces(MediaType.APPLICATION_JSON)
 44    // tag::host-property[]
 45    // tag::APIResponse[]
 46    @APIResponse(
 47        responseCode = "404",
 48        description = "Missing description",
 49        content = @Content(mediaType = "application/json"))
 50    // end::APIResponse[]
 51    //tag::APIResponseSchema[]
 52    @APIResponseSchema(value = Properties.class,
 53        responseDescription = "JVM system properties of a particular host.",
 54        responseCode = "200")
 55    // end::APIResponseSchema[]
 56    // tag::Operation[]
 57    @Operation(
 58        summary = "Get JVM system properties for particular host",
 59        description = "Retrieves and returns the JVM system properties from the system "
 60        + "service running on the particular host.")
 61    // end::Operation[]
 62    // end::host-property[]
 63    public Response getPropertiesForHost(
 64        // tag::Parameter[]
 65        @Parameter(
 66            description = "The host for whom to retrieve "
 67                + "the JVM system properties for.",
 68            required = true,
 69            example = "foo",
 70            schema = @Schema(type = SchemaType.STRING))
 71        // end::Parameter[]
 72        @PathParam("hostname") String hostname) {
 73        // Get properties for host
 74        Properties props = manager.get(hostname);
 75        if (props == null) {
 76            return Response.status(Response.Status.NOT_FOUND)
 77                           .entity("{ \"error\" : "
 78                                   + "\"Unknown hostname " + hostname
 79                                   + " or the resource may not be "
 80                                   + "running on the host machine\" }")
 81                           .build();
 82        }
 83
 84        //Add to inventory to host
 85        manager.add(hostname, props);
 86        return Response.ok(props).build();
 87    }
 88
 89    @GET
 90    @Produces(MediaType.APPLICATION_JSON)
 91    // tag::listContents[]
 92    @APIResponseSchema(value = InventoryList.class,
 93        responseDescription = "host:properties pairs stored in the inventory.",
 94        responseCode = "200")
 95    @Operation(
 96        summary = "List inventory contents.",
 97        description = "Returns the currently stored host:properties pairs in the "
 98        + "inventory.")
 99    // end::listContents[]
100    public InventoryList listContents() {
101        return manager.list();
102    }
103
104}

Clearly, there are many more OpenAPI annotations now, so let’s break them down:

Annotation Description

@APIResponse

Describes a single response from an API operation.

@APIResponseSchema

Convenient short-hand way to specify a simple response with a Java class that could otherwise be specified using @APIResponse.

@Operation

Describes a single API operation on a path.

@Parameter

Describes a single operation parameter.

Since the Open Liberty server was started in development mode at the beginning of the guide, your changes were automatically picked up. Refresh the http://localhost:9080/openapi URL to see the updated OpenAPI tree. The two endpoints at which your JAX-RS endpoint methods are served are now more meaningful:

/inventory/systems:
  get:
    summary: List inventory contents.
    description: Returns the currently stored host:properties pairs in the inventory.
    responses:
      "200":
        description: host:properties pairs stored in the inventory.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InventoryList'
/inventory/systems/{hostname}:
  get:
    summary: Get JVM system properties for particular host
    description: Retrieves and returns the JVM system properties from the system
      service running on the particular host.
    parameters:
    - name: hostname
      in: path
      description: The host for whom to retrieve the JVM system properties for.
      required: true
      schema:
        type: string
      example: foo
    responses:
      "404":
        description: Missing description
        content:
          application/json: {}
      "200":
        description: JVM system properties of a particular host.
        content:
          application/json:
            schema:
              type: object

OpenAPI annotations can also be added to POJOs to describe what they represent. Currently, your OpenAPI document doesn’t have a very meaningful description of the InventoryList POJO and hence it’s very difficult to tell exactly what that POJO is used for. To describe the InventoryList POJO in more detail, augment the src/main/java/io/openliberty/guides/inventory/model/InventoryList.java file with some OpenAPI annotations.

Update the InventoryList class.
src/main/java/io/openliberty/guides/inventory/model/InventoryList.java

Add OpenAPI @Schema annotations to the InventoryList class and the systems variable.

InventoryList.java

 1// tag::copyright[]
 2/*******************************************************************************
 3 * Copyright (c) 2017, 2022 IBM Corporation and others.
 4 * All rights reserved. This program and the accompanying materials
 5 * are made available under the terms of the Eclipse Public License v1.0
 6 * which accompanies this distribution, and is available at
 7 * http://www.eclipse.org/legal/epl-v10.html
 8 *
 9 * Contributors:
10 *     IBM Corporation - Initial implementation
11 *******************************************************************************/
12// end::copyright[]
13package io.openliberty.guides.inventory.model;
14
15import java.util.List;
16import org.eclipse.microprofile.openapi.annotations.media.Schema;
17
18// tag::InventoryList[]
19@Schema(name = "InventoryList",
20description = "POJO that represents the inventory contents.")
21// end::InventoryList[]
22// tag::InventoryListClass[]
23public class InventoryList {
24
25    // tag::Systems[]
26    @Schema(required = true)
27    // end::Systems[]
28    private List<SystemData> systems;
29
30    public InventoryList(List<SystemData> systems) {
31        this.systems = systems;
32    }
33
34    public List<SystemData> getSystems() {
35        return systems;
36    }
37
38    public int getTotal() {
39        return systems.size();
40    }
41}
42// end::InventoryListClass[]

Likewise, annotate the src/main/java/io/openliberty/guides/inventory/model/SystemData.java POJO, which is referenced in the InventoryList class.

Update the SystemData class.
src/main/java/io/openliberty/guides/inventory/model/SystemData.java

Add OpenAPI @Schema annotations to the SystemData class, the hostname variable and the properties variable.

SystemData.java

 1// tag::copyright[]
 2/*******************************************************************************
 3 * Copyright (c) 2017, 2022 IBM Corporation and others.
 4 * All rights reserved. This program and the accompanying materials
 5 * are made available under the terms of the Eclipse Public License v1.0
 6 * which accompanies this distribution, and is available at
 7 * http://www.eclipse.org/legal/epl-v10.html
 8 *
 9 * Contributors:
10 *     IBM Corporation - Initial implementation
11 *******************************************************************************/
12// end::copyright[]
13package io.openliberty.guides.inventory.model;
14
15import java.util.Properties;
16import org.eclipse.microprofile.openapi.annotations.media.Schema;
17
18// tag::SystemData[]
19@Schema(name = "SystemData",
20       description = "POJO that represents a single inventory entry.")
21// end::SystemData[]
22public class SystemData {
23
24    // tag::Hostname[]
25    @Schema(required = true)
26    // end::Hostname[]
27    private final String hostname;
28
29    // tag::Properties[]
30    @Schema(required = true)
31    // end::Properties[]
32    private final Properties properties;
33
34    public SystemData(String hostname, Properties properties) {
35        this.hostname = hostname;
36        this.properties = properties;
37    }
38
39    public String getHostname() {
40        return hostname;
41    }
42
43    public Properties getProperties() {
44        return properties;
45    }
46
47    @Override
48    public boolean equals(Object host) {
49        if (host instanceof SystemData) {
50            return hostname.equals(((SystemData) host).getHostname());
51        }
52        return false;
53    }
54}

Refresh the http://localhost:9080/openapi URL to see the updated OpenAPI tree:

components:
  schemas:
    InventoryList:
      description: POJO that represents the inventory contents.
      required:
      - systems
      type: object
      properties:
        systems:
          type: array
          items:
            $ref: '#/components/schemas/SystemData'
        total:
          format: int32
          type: integer
    SystemData:
      description: POJO that represents a single inventory entry.
      required:
      - hostname
      - properties
      type: object
      properties:
        hostname:
          type: string
        properties:
          type: object

Filtering the OpenAPI tree elements

Filtering of certain elements and fields of the generated OpenAPI document can be done by using the OASFilter interface.

Create the InventoryOASFilter class.
src/main/java/io/openliberty/guides/inventory/filter/InventoryOASFilter.java

InventoryOASFilter.java

 1// tag::copyright[]
 2/*******************************************************************************
 3 * Copyright (c) 2018, 2022 IBM Corporation and others.
 4 * All rights reserved. This program and the accompanying materials
 5 * are made available under the terms of the Eclipse Public License v1.0
 6 * which accompanies this distribution, and is available at
 7 * http://www.eclipse.org/legal/epl-v10.html
 8 *
 9 * Contributors:
10 *     IBM Corporation - Initial implementation
11 *******************************************************************************/
12// end::copyright[]
13package io.openliberty.guides.inventory.filter;
14
15import java.util.Arrays;
16import java.util.Collections;
17
18import org.eclipse.microprofile.openapi.OASFactory;
19import org.eclipse.microprofile.openapi.OASFilter;
20import org.eclipse.microprofile.openapi.models.OpenAPI;
21import org.eclipse.microprofile.openapi.models.info.License;
22import org.eclipse.microprofile.openapi.models.info.Info;
23import org.eclipse.microprofile.openapi.models.responses.APIResponse;
24import org.eclipse.microprofile.openapi.models.servers.Server;
25import org.eclipse.microprofile.openapi.models.servers.ServerVariable;
26
27public class InventoryOASFilter implements OASFilter {
28
29  @Override
30  // tag::filterAPIResponse[]
31  public APIResponse filterAPIResponse(APIResponse apiResponse) {
32    if ("Missing description".equals(apiResponse.getDescription())) {
33      apiResponse.setDescription("Invalid hostname or the system service may not "
34          + "be running on the particular host.");
35    }
36    return apiResponse;
37  }
38  // end::filterAPIResponse[]
39
40  @Override
41  // tag::filterOpenAPI[]
42  // tag::OpenAPI[]
43  public void filterOpenAPI(OpenAPI openAPI) {
44  // end::OpenAPI[]
45    // tag::oasfactory[]
46    openAPI.setInfo(
47        OASFactory.createObject(Info.class).title("Inventory App").version("1.0")
48                  .description(
49                      "App for storing JVM system properties of various hosts.")
50                  .license(
51                      OASFactory.createObject(License.class)
52                                .name("Eclipse Public License - v 1.0").url(
53                                    "https://www.eclipse.org/legal/epl-v10.html")));
54
55    openAPI.addServer(
56        OASFactory.createServer()
57                  .url("http://localhost:{port}")
58                  .description("Simple Open Liberty.")
59                  .variables(Collections.singletonMap("port",
60                                 OASFactory.createServerVariable()
61                                           .defaultValue("9080")
62                                           .description("Server HTTP port."))));
63    // end::oasfactory[]
64  }
65  // end::filterOpenAPI[]
66
67}

The filterAPIResponse() method allows filtering of APIResponse elements. When you override this method, it will be called once for every APIResponse element in the OpenAPI tree. In this case, you are matching the 404 response that is returned by the /inventory/systems/{hostname} endpoint and setting the previously missing description. To remove an APIResponse element or another filterable element, simply return null.

The filterOpenAPI() method allows filtering of the singleton OpenAPI element. Unlike other filter methods, when you override filterOpenAPI(), it is called only once as the last method for a particular filter. Hence, make sure that it doesn’t override any other filter operations that are called before it. Your current OpenAPI document doesn’t provide much information on the application itself or on what server and port it runs on. This information is usually provided in the info and servers elements, which are currently missing. Use the OASFactory class to manually set these and other elements of the OpenAPI tree from the org.eclipse.microprofile.openapi.models package. The OpenAPI element is the only element that cannot be removed, because that would mean removing the whole OpenAPI tree.

Each filtering method is called once for each corresponding element in the model tree. You can think of each method as a callback for various key OpenAPI elements.

Before you can use the filter class that you created, you need to create the microprofile-config.properties file.

Create the configuration file.
src/main/webapp/META-INF/microprofile-config.properties

microprofile-config.properties

1# tag::Scan[]
2mp.openapi.scan.disable = true
3# end::Scan[]
4# tag::Config[]
5mp.openapi.filter = io.openliberty.guides.inventory.filter.InventoryOASFilter
6# end::Config[]

This configuration file is picked up automatically by MicroProfile Config and registers your filter by passing in the fully qualified name of the filter class into the mp.openapi.filter property.

Refresh the http://localhost:9080/openapi URL to see the updated OpenAPI tree:

info:
  title: Inventory App
  description: App for storing JVM system properties of various hosts.
  license:
    name: Eclipse Public License - v 1.0
    url: https://www.eclipse.org/legal/epl-v10.html
  version: "1.0"
servers:
- url: "http://localhost:{port}"
  description: Simple Open Liberty.
  variables:
    port:
      default: "9080"
      description: Server HTTP port.
responses:
  "404":
    description: Invalid hostname or the system service may not be running on
      the particular host.
    content:
      application/json: {}

For more information about which elements you can filter, see the MicroProfile API documentation.

To learn more about MicroProfile Config, visit the MicroProfile Config GitHub repository and try one of the MicroProfile Config guides.

Using pregenerated OpenAPI documents

As an alternative to generating the OpenAPI model tree from code, you can provide a valid pregenerated OpenAPI document to describe your APIs. This document must be named openapi with a yml, yaml, or json extension and be placed under the META-INF directory. Depending on the scenario, the document might be fully or partially complete. If the document is fully complete, then you can disable annotation scanning entirely by setting the mp.openapi.scan.disable MicroProfile Config property to true. If the document is partially complete, then you can augment it with code.

To use the pre-generated OpenAPI document, create the OpenAPI document YAML file.

Create the OpenAPI document file.
src/main/webapp/META-INF/openapi.yaml

openapi.yaml

 1---
 2openapi: 3.0.3
 3info:
 4  title: Inventory App
 5  description: App for storing JVM system properties of various hosts.
 6  license:
 7    name: Eclipse Public License - v 1.0
 8    url: https://www.eclipse.org/legal/epl-v10.html
 9  version: "1.0"
10paths:
11  /inventory/properties:
12    get:
13      operationId: getProperties
14      responses:
15        "200":
16          description: JVM system properties of the host running this service.
17          content:
18            application/json:
19              schema:
20                type: object
21                additionalProperties:
22                  type: string
23  /inventory/systems:
24    get:
25      summary: List inventory contents.
26      description: Returns the currently stored host:properties pairs in the inventory.
27      responses:
28        "200":
29          description: host:properties pairs stored in the inventory.
30          content:
31            application/json:
32              schema:
33                $ref: '#/components/schemas/InventoryList'
34  /inventory/systems/{hostname}:
35    get:
36      summary: Get JVM system properties for particular host
37      description: Retrieves and returns the JVM system properties from the system
38        service running on the particular host.
39      parameters:
40      - name: hostname
41        in: path
42        description: The host for whom to retrieve the JVM system properties for.
43        required: true
44        schema:
45          type: string
46        example: foo
47      responses:
48        "404":
49          description: Invalid hostname or the system service may not be running on
50            the particular host.
51          content:
52            application/json: {}
53        "200":
54          description: JVM system properties of a particular host.
55          content:
56            application/json:
57              schema:
58                type: object
59components:
60  schemas:
61    InventoryList:
62      description: POJO that represents the inventory contents.
63      required:
64      - systems
65      type: object
66      properties:
67        systems:
68          type: array
69          items:
70            $ref: '#/components/schemas/SystemData'
71        total:
72          format: int32
73          type: integer
74    SystemData:
75      description: POJO that represents a single inventory entry.
76      required:
77      - hostname
78      - properties
79      type: object
80      properties:
81        hostname:
82          type: string
83        properties:
84          type: object

This document is the same as your current OpenAPI document with extra APIs for the /inventory/properties endpoint. This document is complete so you can also add the mp.openapi.scan.disable property and set it to true in the src/main/webapp/META-INF/microprofile-config.properties file.

Update the configuration file.
src/main/webapp/META-INF/microprofile-config.properties

Add and set the mp.openapi.scan.disable property to true.

microprofile-config.properties

1# tag::Scan[]
2mp.openapi.scan.disable = true
3# end::Scan[]
4# tag::Config[]
5mp.openapi.filter = io.openliberty.guides.inventory.filter.InventoryOASFilter
6# end::Config[]

Refresh the http://localhost:9080/openapi URL to see the updated OpenAPI tree:

/inventory/properties:
  get:
    operationId: getProperties
    responses:
      "200":
        description: JVM system properties of the host running this service.
        content:
          application/json:
            schema:
              type: object
              additionalProperties:
                type: string

Testing the service

No automated tests are provided to verify the correctness of the generated OpenAPI document. Manually verify the document by visiting the http://localhost:9080/openapi or the http://localhost:9080/openapi/ui URL.

A few tests are included for you to test the basic functionality of the inventory service. If a test failure occurs, then you might have introduced a bug into the code. These tests will run automatically as a part of the integration test suite.

Running the tests

Because you started Open Liberty in dev mode, you can run the tests by pressing the enter/return key from the command-line session where you started dev mode.

You will see the following output:

-------------------------------------------------------
 T E S T S
-------------------------------------------------------
Running it.io.openliberty.guides.system.SystemEndpointIT
Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 1.4 sec - in it.io.openliberty.guides.system.SystemEndpointIT
Running it.io.openliberty.guides.inventory.InventoryEndpointIT
[WARNING ] Interceptor for {http://client.inventory.guides.openliberty.io/}SystemClient has thrown exception, unwinding now
Could not send Message.
[err] The specified host is unknown: java.net.UnknownHostException: UnknownHostException invoking http://badhostname:9080/inventory/properties: badhostname
Tests run: 3, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.264 sec - in it.io.openliberty.guides.inventory.InventoryEndpointIT

Results :

Tests run: 4, Failures: 0, Errors: 0, Skipped: 0

The warning and error messages are expected and result from a request to a bad or an unknown hostname. This request is made in the testUnknownHost() test from the InventoryEndpointIT integration test.

When you are done checking out the service, exit dev mode by pressing CTRL+C in the command-line session where you ran the server, or by typing q and then pressing the enter/return key.

Great work! You’re done!

You have just documented and filtered the APIs of the inventory service from both the code and a static file by using MicroProfile OpenAPI in Open Liberty.

Feel free to try one of the related MicroProfile guides. They demonstrate additional technologies that you can learn and expand on top of what you built here.

For more in-depth examples of MicroProfile OpenAPI, try one of the demo applications available in the MicroProfile OpenAPI GitHub repository.

Guide Attribution

Documenting RESTful APIs by Open Liberty is licensed under CC BY-ND 4.0

Copy file contents

Prerequisites:

Nice work! Where to next?

What did you think of this guide?

Extreme Dislike Dislike Like Extreme Like

What could make this guide better?

Raise an issue to share feedback

Create a pull request to contribute to this guide

Need help?

Ask a question on Stack Overflow

Like Open Liberty? Star our repo on GitHub.

Star