API Connect

 View Only
  • 1.  #HOW TO DO THE SCHEMA VALIDATION FOR OPEN API 3.0 DEFINITION IN API CONNECT V10 ?

    Posted Tue June 21, 2022 04:49 AM
    @Romil Garg

    I have received OpenAPI3.0 file from other team and they're asking me to create an API with the given OpenAPI3.0 file. As per requirement We have to do the Schema validation for the Incoming JSON request at API Connect.  In general we will use VALIDATE policy to do the validation on Coming Request. Currently, In API Connect v10 there was no VALIDATE policy. Now, How can I do the schema validation in API Connect v10 for OpenAPI3.0 Definition.

    I tried writing gateway script but I felt that was not a good practice. Can you please suggest me the way to do the validation of OpenAPI3.0 definition in API Connect for JSON request?

    ------------------------------
    Ravikumar Kunibilli
    ravikumarkunibilli@gmail.com
    ------------------------------


  • 2.  RE: #HOW TO DO THE SCHEMA VALIDATION FOR OPEN API 3.0 DEFINITION IN API CONNECT V10 ?
    Best Answer

    IBM Champion
    Posted Wed June 22, 2022 06:34 AM
    Hi @ravikumar kunibilli - Last I checked Validate Policy is not available for OpenAPI3.0. Your best bet is to push that work to your backend, at least until that policy is made available by IBM. If that's not an option, unfortunately, you will have to rely on the script/custom policy to do it. ​

    ------------------------------
    Romil Garg
    ------------------------------



  • 3.  RE: #HOW TO DO THE SCHEMA VALIDATION FOR OPEN API 3.0 DEFINITION IN API CONNECT V10 ?

    Posted Wed June 22, 2022 07:03 AM
    Edited by ravikumar kunibilli Wed June 22, 2022 07:04 AM
    Hi @Romil Garg- Thanks for the confirmation. I never tried the Validation with custom policy, May I know how can we achieve it. Can we find any relatable documents in knowledge center or any other sites.
    I tried writing gateway script but felt like that was not a good practice. Can we completely rely on .js to do the validation, Was it a good way ?

    ------------------------------
    Ravikumar Kunibilli
    ravikumarkunibilli@gmail.com
    ------------------------------



  • 4.  RE: #HOW TO DO THE SCHEMA VALIDATION FOR OPEN API 3.0 DEFINITION IN API CONNECT V10 ?

    IBM Champion
    Posted Wed June 22, 2022 07:17 AM
    I have not tried that either. I would suggest reaching out to the IBM Support on this. They might have an existing solution that they can point you to. I would still suggest to push that validation to your backend in the meantime.

    ------------------------------
    Romil Garg
    ------------------------------



  • 5.  RE: #HOW TO DO THE SCHEMA VALIDATION FOR OPEN API 3.0 DEFINITION IN API CONNECT V10 ?

    Posted Thu June 30, 2022 04:51 AM
    Thanks for letting me know the possibilities of the validation.

    ------------------------------
    Ravikumar Kunibilli
    ravikumarkunibilli@gmail.com
    ------------------------------



  • 6.  RE: #HOW TO DO THE SCHEMA VALIDATION FOR OPEN API 3.0 DEFINITION IN API CONNECT V10 ?

    Posted Fri July 01, 2022 09:11 AM

    Hi Ravikumar,
    The validate policy for OAI 3.0 Apis will be available in the upcoming 10.5 release. 


    Best Regards, 
    Steve



    ------------------------------
    Steve Linn
    Senior Consulting I/T Specialist
    IBM
    ------------------------------



  • 7.  RE: #HOW TO DO THE SCHEMA VALIDATION FOR OPEN API 3.0 DEFINITION IN API CONNECT V10 ?

    Posted Thu July 07, 2022 10:49 AM

    Just  to clarify my previous remarks for the DataPower 10.5 release, the initial release of 10.5.0.0 was only for the new IDG x3 appliance.  Subsequent fix packs for VMWare ova support and the IDG x2 appliance will be in subsequent fix packs over the next few months.  If you're needing 10.5 on one of these platforms, stay tuned.

    Regards,

    Steve



    ------------------------------
    Steve Linn
    Senior Consulting I/T Specialist
    IBM
    ------------------------------