API Connect

Hi Hamza,

The apim module in v10 provides v5 compatibility.  The module  also interfaces the new v10 context with the migrated code using the apim.functionname without needed to change.  The recommendation for new APIs is to use the native context functions (and thus the warnings), but understand that the results of the context functions may require some additional or different coding procedures.  For example, apim.getvariable('contextname.body')  if that payload is an XML payload as determined by contextname.headers.content-type, in v5 was returned as a XML Nodelist, whereas a parsed XML document in the v10 context will return a XML Document.  The apim module handles that difference for you assuming you have subsequent nodelist functions processing that nodelist, whereas when writing new code, you work directly with the XML Document that is returned.

Best Regards,

Steve

Hi Steve,

Thank for your explanation.

But if I need to get full document (full API's swagger/yaml) that has possible to retrieve in version v5 and v10.0.1.9 without warning by methods:  apim.getVariable('document') in v5 and apim.getSwaggerDocument() in v10.0.1.9 , how can I do this? 

Maybe there is any workaround ?

Thanks,

And with Regards,

Sergey

Hi Hamza,

The apim module in v10 provides v5 compatibility.  The module  also interfaces the new v10 context with the migrated code using the apim.functionname without needed to change.  The recommendation for new APIs is to use the native context functions (and thus the warnings), but understand that the results of the context functions may require some additional or different coding procedures.  For example, apim.getvariable('contextname.body')  if that payload is an XML payload as determined by contextname.headers.content-type, in v5 was returned as a XML Nodelist, whereas a parsed XML document in the v10 context will return a XML Document.  The apim module handles that difference for you assuming you have subsequent nodelist functions processing that nodelist, whereas when writing new code, you work directly with the XML Document that is returned.

Best Regards,

Steve

Hi Sergey,

The native way to retrieve the swagger in a v10 API Gateway API without using the apim compatibility module is to use the asynchronous readAsJSON function as follows

context.swagger.readAsJSON(function(error, swaggerDoc) {  // continue with the code that would have been done after the apim.getSwaggerDocument  // with either by embedding that code here or calling a callback function};

The apim.getSwaggerDocument compatibility function will call the callback function for you, but you'll need to make that call yourself.
Best Regards,
Steve

Hi Steve,

Thank for your explanation.

But if I need to get full document (full API's swagger/yaml) that has possible to retrieve in version v5 and v10.0.1.9 without warning by methods:  apim.getVariable('document') in v5 and apim.getSwaggerDocument() in v10.0.1.9 , how can I do this? 

Maybe there is any workaround ?

Thanks,

And with Regards,

Sergey

Hi Hamza,

The apim module in v10 provides v5 compatibility.  The module  also interfaces the new v10 context with the migrated code using the apim.functionname without needed to change.  The recommendation for new APIs is to use the native context functions (and thus the warnings), but understand that the results of the context functions may require some additional or different coding procedures.  For example, apim.getvariable('contextname.body')  if that payload is an XML payload as determined by contextname.headers.content-type, in v5 was returned as a XML Nodelist, whereas a parsed XML document in the v10 context will return a XML Document.  The apim module handles that difference for you assuming you have subsequent nodelist functions processing that nodelist, whereas when writing new code, you work directly with the XML Document that is returned.

Best Regards,

Steve

Hi Sergey,

The native way to retrieve the swagger in a v10 API Gateway API without using the apim compatibility module is to use the asynchronous readAsJSON function as follows

context.swagger.readAsJSON(function(error, swaggerDoc) {  // continue with the code that would have been done after the apim.getSwaggerDocument  // with either by embedding that code here or calling a callback function};

The apim.getSwaggerDocument compatibility function will call the callback function for you, but you'll need to make that call yourself.
Best Regards,
Steve

Hi Steve,

Thank for your explanation.

But if I need to get full document (full API's swagger/yaml) that has possible to retrieve in version v5 and v10.0.1.9 without warning by methods:  apim.getVariable('document') in v5 and apim.getSwaggerDocument() in v10.0.1.9 , how can I do this? 

Maybe there is any workaround ?

Thanks,

And with Regards,

Sergey

Hi Hamza,

The apim module in v10 provides v5 compatibility.  The module  also interfaces the new v10 context with the migrated code using the apim.functionname without needed to change.  The recommendation for new APIs is to use the native context functions (and thus the warnings), but understand that the results of the context functions may require some additional or different coding procedures.  For example, apim.getvariable('contextname.body')  if that payload is an XML payload as determined by contextname.headers.content-type, in v5 was returned as a XML Nodelist, whereas a parsed XML document in the v10 context will return a XML Document.  The apim module handles that difference for you assuming you have subsequent nodelist functions processing that nodelist, whereas when writing new code, you work directly with the XML Document that is returned.

Best Regards,

Steve

Hi Steve,

Thank you for explaining this, I need a native way to retrieve this header

var auth = apim.getvariable('request.headers.authorization').toString();

 And for returning an authentication error

apim.error('authentication_error', 401, 'Unauthorized', error);

what's the best practice here?

Hi Sergey,

The native way to retrieve the swagger in a v10 API Gateway API without using the apim compatibility module is to use the asynchronous readAsJSON function as follows

context.swagger.readAsJSON(function(error, swaggerDoc) {  // continue with the code that would have been done after the apim.getSwaggerDocument  // with either by embedding that code here or calling a callback function};

The apim.getSwaggerDocument compatibility function will call the callback function for you, but you'll need to make that call yourself.
Best Regards,
Steve

Hi Steve,

Thank for your explanation.

But if I need to get full document (full API's swagger/yaml) that has possible to retrieve in version v5 and v10.0.1.9 without warning by methods:  apim.getVariable('document') in v5 and apim.getSwaggerDocument() in v10.0.1.9 , how can I do this? 

Maybe there is any workaround ?

Thanks,

And with Regards,

Sergey

Hi Hamza,

The apim module in v10 provides v5 compatibility.  The module  also interfaces the new v10 context with the migrated code using the apim.functionname without needed to change.  The recommendation for new APIs is to use the native context functions (and thus the warnings), but understand that the results of the context functions may require some additional or different coding procedures.  For example, apim.getvariable('contextname.body')  if that payload is an XML payload as determined by contextname.headers.content-type, in v5 was returned as a XML Nodelist, whereas a parsed XML document in the v10 context will return a XML Document.  The apim module handles that difference for you assuming you have subsequent nodelist functions processing that nodelist, whereas when writing new code, you work directly with the XML Document that is returned.

Best Regards,

Steve