Skip to content

Via CRs

In this section, we'll explore Kubernetes Native API Development in WSO2 APK. Learn how to define APIs using Kubernetes resources for streamlined API management. A single API in APK project is defined using a set of combined Kubernetes custom resources (CRs).

  • API - With the API CRs, you can effortlessly design and manage APIs using Kubernetes-native tools. Simplify the deployment process and focus on what matters most – crafting outstanding APIs. This is the root level resource for an API. API related metadata are also defined in this CR.

  • HTTPRoute - The HTTPRoute CR empowers you to configure HTTP routes and filters for your API efficiently. You have to refer to HTTPRoute resources from API CRs.

  • Backend - Elevate your endpoint configurations, including resiliency settings, using the Backend CR. Ensure the reliability and availability of your API backends for uninterrupted service.

These are the basic resource you need to use specifically for APK. We have other resources for complex use cases which are described under separate sections.

Let's create a simple API with following steps:

Create API CR

In the following CR, we have defined a REST API giving the name, context, and version information for the API. We have also referred to HTTPRoute resource in spec.production.httpRouteRefs[0] path which we create in the next step.

kind: API
  name: http-bin-api
  apiName: HTTP Bin API
  apiType: REST
  apiVersion: 1.0.0
  basePath: /http-bin-api/1.0.0
  organization: default
  - httpRouteRefs:
    - prod-http-route-http-bin-api


If your API has many resources and cannot be defined within a single HTTPRoute resource, then you have to create two or more HTTPRoutes and list them under spec.production.httpRouteRefs.

Create HTTPRoute CR

This is the resource where you define resources of your API. This HTTPRoute is linked to the API by referring to this resource name from the API resource.

kind: HTTPRoute
  name: prod-http-route-http-bin-api
    - group:
      kind: Gateway
      name: wso2-apk-default
      sectionName: httpslistener
  - backendRefs:
    - group:
      kind: Backend
      name: http-bin-backend
    - path:
        type: PathPrefix
        value: /

Here, we have used as the virtual hostname for this API. The spec.parentRefs[0] parameter defines the Gateway to which this HTTPRoute is deployed. We have defined a single rule with a PathPrefix match type, and the URLRewrite filter with ReplacePrefixMatch to rewrite the API context prefix so that only the remainder of the path is sent to the actual backend.

Create Backend CR

In the above created HTTPRoute resource we have reffered to a Backend resource in spec.rules[0].backendRefs[0] path. That Backend should be created as below:

kind: Backend
  name: http-bin-backend
  - host:
    port: 80

Here, we have set the domain name as the host with port 80, which is an insecure port. To make it a TLS-secured endpoint, refer to the Manage Certificate section.

If your backend is a Kubernetes-native Service, then derive the following value according to your Service and use it as the host.


Once you have designed your APIs using these essential CRs, the next step is to apply them to the Kubernetes API server. APK will process and deploy your APIs seamlessly, taking full advantage of the Kubernetes infrastructure.

kubectl apply -f <path_to_CR_files>