Using declarative APIs

Create a secret containing the credentials for the API manager you want the declarative API to use.

You can have multiple secrets in the same namespace, and also have APIs that reference different secrets.

1. Begin by creating the secret:

   cat <<EOF | oc apply -f -
   apiVersion: v1
   kind: Secret
   metadata:
     name: apim-credentials
   type: Opaque
   stringData:
     base_url: https://<api-connect-base-url>
     username: <username>
     password: <password>
     trusted_cert: |-
       <certificate>
   EOF

2. To get the values the you need to use within the secret, run the following command in the namespace where the API manager is installed, replacing <instance-name> with the name of the API manager instance:

   oc get ManagementCluster <instance-name>-mgmt -o json | jq -r '.status.endpoints[] | select(.name=="platformApi")'

   This returns a JSON object with the following structure, where <api-secret-name>, and <api-connect-base-url>, are values that change depending on the name of your APIC manager instance.

   {
     "name": "platformApi",
     "type": "API",
     "secretName: "<api-secret-name>",
     "uri": "<api-connect-base-url>"
   }

3. Replace the values in the secret that you created in the first step with the previously returned values, as follows:

   • Replace <api-connect-base-url> with the values that were generated in the previous command.

   • Replace <certificate> with the certificate content for a cert that the API manager trusts. On OpenShift, get this content by running the following command in the namespace where the API manager is installed, replacing <api-secret-name>, with the value that was generated in the previous step:

     oc get secret <api-secret-name> -o json | jq -r '.data["ca.crt"]' | base64 --decode

   • Replace <username> with the username you want to use.

   • Replace <password> with the password for that username.

1. Log into your cluster, using your OpenShift user credentials:

   oc login

2. Create a API YAML file. For example, you could create a file called api.yaml with the following example configuration. Update the values as indicated:

   • For metadata.namespace, enter your project (namespace) name.

   • For spec.definition, specify either an external, configMap or integrationRuntime object:

     • For spec.definition.configMap, specify the name of the configMap that contains the API document. The document can be compressed data in gzip, bzip2 and zip format to help avoid 1MB limit.

     • For spec.definition.external, specify an external endpoint containing the API definition to be fetched via a REST GET call.

     • For spec.definition.integrationRuntime, specify which REST API document to retrieve from a running IntegrationRuntime in the same namespace as this API. For details on how to configure the spec.definition section, refer to the "Custom resource values" section in this page.

   • Define a spec.share.apim section only if you want this API to be created as a draft in an API manager instance:

     • For credentialsSecret, specify the name created in the Create a secret with your API manager credentials section.

     • For providerOrg, specify the provider organization in which the draft will be created.

   • Set any other configuration values as required.

     apiVersion: apiconnect.ibm.com/v1beta1
     kind: API
     metadata:
       name: example-api
       namespace: <namespace>
     spec:
       definition:
         configMap: example-configmap
       share:
         apim:
           credentialsSecret: apim-credentials
           providerOrg: main-demo

3. Apply the YAML file to the cluster:

   oc apply -f api.yaml

4. Check the status of the declarative API by running the following command in the project (namespace) where it was deployed:

   oc get api