github.com/ouraigua/jenkins-library@v0.0.0-20231028010029-fbeaf2f3aa9b/documentation/docs/steps/apiProxyList.md (about)

     1  # ${docGenStepName}
     2  
     3  ## ${docGenDescription}
     4  
     5  With this step, you can retrieve all the API proxies from the API portal. An API Proxy is a concept in API Management, capability of SAP Integration Suite, which anonymizes any HTTP endpoints like REST, OData, or SOAP and enhance it with policies and routes.
     6  
     7  An API proxy is a discrete representation of an API. It is implemented as a set of configuration files, policies, and code snippets that rely on the resource information provided by API Management. For more information, see the document [API Proxy](https://help.sap.com/doc/654e5912ee554d46bcc6347599fb2096/CLOUD/en-US/Unit%2004.3%20-%20API%20Proxy%20-%20API%20Resource.pdf/)
     8  
     9  To consume the ApiProxyList step, proceed as follows:
    10  
    11  * Copy the SAP API management service key from the SAP BTP cockpit. Go to instance and subscriptions → service API Management, API portal, which was created under apiportal-apiaccess plan.
    12  * Store your service key created for API Management in the Jenkins server as a secret text.
    13  * Create a new Jenkins pipeline designated for the ApiProxyList step.
    14  * Execute the pipeline and validate the step exection results as explained in the blog [Integration Suite Piper commands](https://blogs.sap.com/2022/01/05/orking-with-integration-suite-piper-commands/)
    15  * Use the ApiProxyList step to get the api proxy list from the API portal.
    16  * ApiProxyList only supports GET operation.
    17  
    18  ## Prerequisites
    19  
    20  ## ${docGenParameters}
    21  
    22  ## ${docGenConfiguration}
    23  
    24  ## ${docJenkinsPluginDependencies}
    25  
    26  ## Example
    27  
    28  Configuration example for a `Jenkinsfile`:
    29  
    30  ```groovy
    31  apiProxyList script: this
    32  ```
    33  
    34  Configuration example for a YAML file(for example `.pipeline/config.yaml`):
    35  
    36  ```yaml
    37  steps:
    38    <...>
    39    apiProxyList:
    40      apimApiServiceKeyCredentialsId: 'MY_API_SERVICE_KEY'
    41      Top: MY_API_PROXY_GET_N_ENTITIES
    42      Skip: MY_API_PROXY_SKIP_N_ENTITIES
    43      Filter: MY_API_PROXY_FILTER_BY_ENTITY_FIELD
    44      Orderby: MY_API_PROXY_ORDER_BY_ENTITY_FIELD
    45      Count: MY_API_PROXY_ORDER_ENTITY_COUNT
    46      Search: MY_API_PROXY_SEARCH_BY_ENTITY_FIELD
    47      Select: MY_API_PROXY_SELECT_BY_ENTITY_FIELD
    48      Expand: MY_API_PROXY_EXPAND_BY_ENTITY_FIELD
    49  ```