Skip to content

Latest commit

 

History

History
 
 

scenario-10

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
README.md
README.md
 
 
interceptor_swagger.yaml
interceptor_swagger.yaml
 
 
modifyResponse.bal
modifyResponse.bal
 
 
validateQueryPrams.bal
validateQueryPrams.bal
 
 

README.md

Scenario 10 - Apply interceptors to an API

  • This scenario describes how to apply interceptors to carry out transformations and mediations on the requests and responses.
  • First, we need to implement custom request interceptors and response interceptors. We have provided sample request and response interceptors in scenario-10. If you want to learn more about implementing custom interceptors you can refer the document adding interceptors.
  • Then we need to Initialize a new API project and add the custom interceptor files in interceptors folder.
  • We need to refer the interceptors in swagger definition in order to apply them on the requests and responses.
  • Finally, we will invoke the API and observe how the added interceptors act on requests and responses.

Important:

Follow the main README and deploy the api-operator and configuration files. Make sure to set the analyticsEnabled to "true" and deploy analytics secret with credentials to analytics server and certificate, if you want to check analytics.

Deploying the artifacts

  • Init the API project using CLI. This will Initialize a new API project in same directory.

    >> apictl init petstore-int --oas=interceptor_swagger.yaml

Output:    
Initializing a new WSO2 API Manager project in ./product-apim-tooling/import-export-cli/build/target/apimcli/petstore-int
Project initialized
Open README file to learn more

  • Copy the modifyResponse.bal and validateQueryPrams.bal files in scenario-10 into the petstore-int/Interceptors folder.

    >> cp modifyResponse.bal validateQueryPrams.bal petstore-int/Interceptors

  • We have defined a function validateResponse in modifyResponse.bal file which check whether the response payload is json and if so then the payload will be modified as follows.

    "pets": payload,
"length": payload length

  • In validateQueryPrams.bal file we have defined a function validateRequest which check the query parameter "status" of the request URL and validate the request accordingly.

  • In order to refer interceptor functions in swagger definition we have already modified the swagger definition by adding following OpenAPI extensions with interceptor function names.

    • validateQueryPrams.bal file consists with validateRequest function which modify the request flow. we have added the function name validateRequest in the swagger definition as follow.

      x-wso2-request-interceptor: validateRequest

    • modifyResponse.bal file consists with validateResponse function which modify the response flow. we have added the function name validateResponse in the swagger definition as follow.

      x-wso2-response-interceptor: validateResponse

  • Execute the following to expose pet-store as an API.

  • Create the API

    >> apictl add api -n petstore-int --from-file=petstore-int

Output:
Processing swagger 1: petstore-int
creating configmap with swagger definition
configmap/petstore-int-1-swagger created
creating configmap with ballerina interceptors
configmap/petstore-int-1-bal-interceptors created
creating API definition
api.wso2.com/petstore-int created

  • Get service details to invoke the API. (Please wait until the external-IP is populated in the corresponding service)

    >> apictl get services

Output:
NAME            TYPE           CLUSTER-IP   EXTERNAL-IP       PORT(S)                         AGE
petstore-int   LoadBalancer   10.83.4.44   104.197.114.248   9095:30680/TCP,9090:30540/TCP   8m20s
    • You can see petstore-int service has been exposed as a managed API.
    • Get the external IP of the managed API's service

  • Invoking the API

    TOKEN=eyJ4NXQiOiJNell4TW1Ga09HWXdNV0kwWldObU5EY3hOR1l3WW1NNFpUQTNNV0kyTkRBelpHUXpOR00wWkdSbE5qSmtPREZrWkRSaU9URmtNV0ZoTXpVMlpHVmxOZyIsImtpZCI6Ik16WXhNbUZrT0dZd01XSTBaV05tTkRjeE5HWXdZbU00WlRBM01XSTJOREF6WkdRek5HTTBaR1JsTmpKa09ERmtaRFJpT1RGa01XRmhNelUyWkdWbE5nX1JTMjU2IiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJhZG1pbkBjYXJib24uc3VwZXIiLCJhdWQiOiJKRmZuY0djbzRodGNYX0xkOEdIVzBBR1V1ME1hIiwibmJmIjoxNTk3MjExOTUzLCJhenAiOiJKRmZuY0djbzRodGNYX0xkOEdIVzBBR1V1ME1hIiwic2NvcGUiOiJhbV9hcHBsaWNhdGlvbl9zY29wZSBkZWZhdWx0IiwiaXNzIjoiaHR0cHM6XC9cL3dzbzJhcGltOjMyMDAxXC9vYXV0aDJcL3Rva2VuIiwiZXhwIjoxOTMwNTQ1Mjg2LCJpYXQiOjE1OTcyMTE5NTMsImp0aSI6IjMwNmI5NzAwLWYxZjctNDFkOC1hMTg2LTIwOGIxNmY4NjZiNiJ9.UIx-l_ocQmkmmP6y9hZiwd1Je4M3TH9B8cIFFNuWGHkajLTRdV3Rjrw9J_DqKcQhQUPZ4DukME41WgjDe5L6veo6Bj4dolJkrf2Xx_jHXUO_R4dRX-K39rtk5xgdz2kmAG118-A-tcjLk7uVOtaDKPWnX7VPVu1MUlk-Ssd-RomSwEdm_yKZ8z0Yc2VuhZa0efU0otMsNrk5L0qg8XFwkXXcLnImzc0nRXimmzf0ybAuf1GLJZyou3UUTHdTNVAIKZEFGMxw3elBkGcyRswzBRxm1BrIaU9Z8wzeEv4QZKrC5NpOpoNJPWx9IgmKdK2b3kIWJEFreT3qyoGSBrM49Q
    >> curl -X GET "https://<External_IP>:9095/petstoreint/v1/pet/findByStatus?status=available"  -H "accept: application/xml" -H "Authorization:Bearer $TOKEN" -k

    • Once you execute the above command, it will call to the managed API (petstore-int), which then call its endpoint(https://petstore.swagger.io/v2). If the request is success, you would be able to see the response as below.

      <?xml version="1.0" encoding="UTF-8" standalone="yes"?><pets><Pet><category><id>12531424102019</id><name>dragon name string</name></category><id>32132142</id><name>dragon</name><photoUrls><photoUrl>string</photoUrl></photoUrls><status>available</status><tags><tag><id>12531424102019</id><name>string</name></tag></tags></Pet><Pet><category><id>0</id><name>dldlld</name></category><id>32132143</id><name>doggie</name><photoUrls><photoUrl>string</photoUrl></photoUrls><status>available</status><tags><tag><id>0</id><name>string</name></tag></tags></Pet> ……

    • Then invoke the API with an "status" query parameter that is not even "available", "pending", "sold" or "soon" to test the request interceptor as follows.

      >> curl -X GET "https://<External_IP>:9095/petstoreint/v1/pet/findByStatus?status=invalid_status"  -H "accept: application/xml" -H "Authorization:Bearer $TOKEN" -k

      • Once you execute the above command, you will get the error message by indicating invalid request as follows.

        {"error":"Invalid status parameter"}

    • Then invoke the API without "status" query parameter to test the request interceptor as follows.

      >> curl -X GET "https://<External_IP>:9095/petstoreint/v1/pet/findByStatus"  -H "accept: application/xml" -H "Authorization:Bearer $TOKEN" -k

      • Once you execute the above command, you will get the error message by indicating invalid request as follows.

        {"error":"Missing a required parameter"}

    • Then invoke the API with "accept: application/json" header to test the response interceptor as follows.

      >> curl -X GET "https://<External_IP>:9095/petstoreint/v1/pet/findByStatus?status=available"  -H "accept: application/json" -H "Authorization:Bearer $TOKEN" -k

      • Once you execute the above command, you will get the response as follows.

        {
    "pets":[{"id":15435006003237, "photoUrls":[], "tags":[], "status":"available"}, {"id":3487237947289472730, "photoUrls":[], "tags":[], "status":"available"}], 
    "length":20509
}

  • Delete the API

    >> apictl delete api petstore-int

Output:
api.wso2.com "petstore-int" deleted