Home
Getting Started
This guide provides an overview and describes the tasks to get you started with HCL OneTest™ API.
Getting started with testing
You can start using HCL OneTest™ API by completing the preliminary tasks such as creating and running a test, creating and running a stub, recording an HTTP proxy, and running a stub in a Docker container.
Creating and running a test
You can create and run a test in HCL OneTest™ API by importing a Swagger definition of an API. You can also find pointers for creating and running tests when the system under test does not have a Swagger definition.

Getting Started
This guide provides an overview and describes the tasks to get you started with HCL OneTest™ API.
- HCL OneTest™ API overview
  You can use HCL OneTest™ API to create, modify, and run service tests.
- Testing methodology
  By following four basic guidelines, you can incorporate HCL OneTest™ API into your testing methodology. These guidelines drive efficient and expedient integration testing, and they can be applied to your testing process and infrastructure requirements.
- Service-oriented architecture (SOA) testing
  A SOA consists of business processes that are implemented by linking individual services. The linking can be done programmatically or with tools based on Business Process Execution Language (BPEL). SOA testing can be challenging because there is no GUI; the focus is on testing interfaces and services.
- Getting started with testing
  You can start using HCL OneTest™ API by completing the preliminary tasks such as creating and running a test, creating and running a stub, recording an HTTP proxy, and running a stub in a Docker container.
  - Creating and running a test
    You can create and run a test in HCL OneTest™ API by importing a Swagger definition of an API. You can also find pointers for creating and running tests when the system under test does not have a Swagger definition.
    - Creating a project
      Creating a project is the first step to start working with HCL OneTest™ API. A project contains the basic settings used by tests. You can also find different interactive guides on the Home page that provide you with information on the common tasks that you can accomplish in HCL OneTest API.
  - Creating and running a stub
    Integration testing in a real environment can be difficult because not all components are always available, even though the requirement is to test all the components of an application. With HCL OneTest™ API, you can create reusable and maintainable stubs (virtual services), which you can use in testing until the actual components become available. You can create and run a stub with a WSDL file.
  - Discovering, Recording, and Intercepting an HTTP proxy
    You can create stubs (virtual services) when you do not have a service or an API definition file such as WSDL or Swagger. You can enable the stub to use an HTTP proxy as the transport for messaging, then use the topology discovery capabilities to discover the endpoints and intercept the endpoints. You can record an operation and verify if the service is virtualized by disabling the server application.
  - Running a stub in a Docker container
    You can package a stub into a Docker image and then run the stub in a Docker container. You can run the stub anywhere that you have a Docker environment, whether on a private cloud or public cloud.
- HCL® Quality Server overview
  HCL OneTest™ Virtualization stubs designed in HCL OneTest API are published to HCL® Quality Server, which holds them in a repository.
- HCL OneTest™ API accessibility features
  Users who have a physical disability, such as limited vision, can review the available accessibility features to use HCL OneTest™ API.

Creating and running a test

You can create and run a test in HCL OneTest™ API by importing a Swagger definition of an API. You can also find pointers for creating and running tests when the system under test does not have a Swagger definition.

You must perform the following sub tasks in sequence: