Running the application

Go to the http://HOST:PORT/openapi/ui/ URL to see the OpenAPI user interface (UI) that provides API documentation and a client to test the API endpoints that you create after you see a message similar to the following example:

CWWKZ0001I: Application guide-mongodb-intro started in 5.715 seconds.

Try the Create operation

From the OpenAPI UI, test the create operation at the POST /api/crew endpoint by using the following code as the request body:

{
  "name": "Member1",
  "rank": "Officer",
  "crewID": "000001"
}

This request creates a new document in the Crew collection with a name of Member1, rank of Officer, and crew ID of 000001.

You’ll receive a response that contains the JSON object of the new crew member, as shown in the following example:

{
  "Name": "Member1",
  "Rank": "Officer",
  "CrewID": "000001",
  "_id": {
    "$oid": "<<ID>>"
  }
}

The <<ID>> that you receive is a unique identifier in the collection. Save this value for future commands.

Try the Retrieve operation

From the OpenAPI UI, test the read operation at the GET /api/crew endpoint. This request gets all crew member documents from the collection.

You’ll receive a response that contains an array of all the members in your crew. The response might include crew members that were created in the Try what you’ll build section of this guide:

[
  {
    "_id": {
      "$oid": "<<ID>>"
    },
    "Name": "Member1",
    "Rank": "Officer",
    "CrewID": "000001"
  }
]

Try the Update operation

From the OpenAPI UI, test the update operation at the PUT /api/crew/{id} endpoint, where the {id} parameter is the <<ID>> that you saved from the create operation. Use the following code as the request body:

{
  "name": "Member1",
  "rank": "Captain",
  "crewID": "000001"
}

This request updates the rank of the crew member that you created from Officer to Captain.

You’ll receive a response that contains the JSON object of the updated crew member, as shown in the following example:

{
  "Name": "Member1",
  "Rank": "Captain",
  "CrewID": "000001",
  "_id": {
    "$oid": "<<ID>>"
  }
}

Try the Delete operation

From the OpenAPI UI, test the delete operation at the DELETE/api/crew/{id} endpoint, where the {id} parameter is the <<ID>> that you saved from the create operation. This request removes the document that contains the specified crew member object id from the collection.

You’ll receive a response that contains the object id of the deleted crew member, as shown in the following example:

{
  "_id": {
    "$oid": "<<ID>>"
  }
}

Now, you can check out the microservice that you created by going to the http://HOST:PORT/CONTEXT_ROOT/ URL.

Testing the application

Next, you’ll create integration tests to ensure that the basic operations you implemented function correctly.

Create the CrewServiceIT class.
src/test/java/it/io/openliberty/guides/application/CrewServiceIT.java

CrewServiceIT.java

link:finish/src/test/java/it/io/openliberty/guides/application/CrewServiceIT.java[role=include]

The test methods are annotated with the @Test annotation.

The following test cases are included in this class:

• testAddCrewMember() verifies that new members are correctly added to the database.

• testUpdateCrewMember() verifies that a crew member’s information is correctly updated.

• testGetCrewMembers() verifies that a list of crew members is returned by the microservice API.

• testDeleteCrewMember() verifies that the crew members are correctly removed from the database.

You’ll see the following output:

-------------------------------------------------------
 T E S T S
-------------------------------------------------------
Running it.io.openliberty.guides.application.CrewServiceIT
   === Adding 2 crew members to the database. ===
      === Done. ===
   === Updating crew member with id 5df8e0a004ccc019976c7d0a. ===
      === Done. ===
   === Listing crew members from the database. ===
      === Done. There are 2 crew members. ===
   === Removing 2 crew members from the database. ===
      === Done. ===
Tests run: 4, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.411 s - in it.io.openliberty.guides.application.CrewServiceIT
Results:
Tests run: 4, Failures: 0, Errors: 0, Skipped: 0