Extend Existing APIs

Applies to ReadyAPI 3.7, last modified on April 19, 2021

After you create a project, your API may change. Usually, you can automatically update the definition by re-importing the API definition file, but you may also choose to update it manually. You can find information about how to expand your API in this topic.

Extend REST APIs

REST APIs offer a large degree of customization. You can add any element to the existing definition:

  • Resource – Right-click the needed service to add the resource to and select New Resource. In the subsequent dialog, enter the resource path and method.

    Tip: You can also add a resource to the existing one. To do this, right-click the resource and select New Child Resource.
  • Method – Right-click the resource and select New Method.

  • Request  – Right-click the method and select New Request.

Extend GraphQL APIs

When you import a GraphQL API to your project, ReadyAPI generates queries and mutations described in a schema. Each generated query and mutation has one request. You can add additional queries, mutations, and individual requests:

  • Query - Right-click a GraphQL service and select New GraphQL Query.

  • Mutation - Right-click a GraphQL service and select New GraphQL Mutation.

  • Request - Right-click a query or mutation and select Add Request.

Manually added queries and mutations will not have links to the GraphQL schema, so ReadyAPI cannot validate their requests.

Extend Kafka APIs

You can add additional topics (channels) and operations to your Kafka API:

  • Channel - Right-click a Kafka service and select Add Channel.

  • Operation - Right-click a channel and select Add Subscriber or Add Publisher.

Extend SOAP APIs

In SOAP API, the WSDL defines the operations. To add or remove operations, you need to import a new WSDL. To add requests, right-click the operation in the Navigator and select New Request.

See Also

Refactoring REST APIs
Organizing APIs
Adding More APIs to Existing Projects

Highlight search results