Re: REST web service APIs

Hi, it is a viable alternative. There are multiple ways to do this and
you may choose the best one that suits your needs. I will also point out
that integrated web services server[1] documents it services via Swagger.


[1] http://www.ibm.com/support/docview.wss?uid=isg3T1026868


"WEB400" <web400-bounces@xxxxxxxxxxxx> wrote on 03/22/2018 08:22:18 PM:

From: Nathan Andelin <nandelin@xxxxxxxxx>
To: "Web Enabling the IBM i (AS/400 and iSeries)" <web400@xxxxxxxxxxxx>
Date: 03/22/2018 08:22 PM
Subject: [WEB400] REST web service APIs
Sent by: "WEB400" <web400-bounces@xxxxxxxxxxxx>

We've discussed the idea of using iToolkit for Node.js to invoke SQL
statements, commands, programs, and procedures on IBM i. I'm going to
suggest an alternative.

How many web developers are familiar with the "openAPI specification" or
"OAS", and tools like Swagger that assist in designing, building,
documenting, and testing REST web-service APIs?

https://urldefense.proofpoint.com/v2/url?
u=https-3A__swagger.io_&d=DwICAg&c=jf_iaSHvJObTbx-siA1ZOg&r=1i-
jGlz0-JTK1aLHcsU-

ew&m=Yv5xU_USYP5u4HJSsOuY4RBy6uhsbf7sKND1JI54YY0&s=mV2dbEz_wlrPKwbxV6v4sCTCxixd5FbuKjnKZ5aM3Ok&e=

Rather than invoking iToolkit functions in JavaScript, all client
applications (whether Node or whatever) "request" IBM i services via

common

URLs and HTTP put, post, get, and delete methods. For example:

post /pet - Add new pet to pet store.
put /pet - Update existing pet.
get /pet/{petID] - Get pet record by ID.
delete /pet/{petID} - Delete pet record by ID.

Request and responses encapsulate JSON structures such as:

{
"id": 0,
"category": {
"id": 0,
"name": "string"
},
"name": "doggie",
"photoUrls": [
"string"
],
"tags": [
{
"id": 0,
"name": "string"
}
],
"status": "available"
}

Does anyone else see advantages to this approach?
--
This is the Web Enabling the IBM i (AS/400 and iSeries) (WEB400) mailing

list

To post a message email: WEB400@xxxxxxxxxxxx
To subscribe, unsubscribe, or change list options,
visit: https://urldefense.proofpoint.com/v2/url?

u=https-3A__lists.midrange.com_mailman_listinfo_web400&d=DwICAg&c=jf_iaSHvJObTbx-

siA1ZOg&r=1i-jGlz0-JTK1aLHcsU-

ew&m=Yv5xU_USYP5u4HJSsOuY4RBy6uhsbf7sKND1JI54YY0&s=6WkbIIKUsq7fk0l1uS8jw0X9Wjm9YrIph8tLt-

ggKms&e=
or email: WEB400-request@xxxxxxxxxxxx
Before posting, please take a moment to review the archives
at https://urldefense.proofpoint.com/v2/url?
u=https-3A__archive.midrange.com_web400&d=DwICAg&c=jf_iaSHvJObTbx-
siA1ZOg&r=1i-jGlz0-JTK1aLHcsU-

ew&m=Yv5xU_USYP5u4HJSsOuY4RBy6uhsbf7sKND1JI54YY0&s=YUSkplzlJgDzgLq8ZyrlL-8JF03Nj6Up6pFoTitQbgo&e=

.