Difference between revisions of "I2Rest API Implementation"

From i2Rest
Jump to: navigation, search
(Created page with "{{DISPLAYTITLE:I2Rest API Implementation process}} <span style="color:red">i2Rest Server использует формат PCML как основу для описания п...")
 
Line 1: Line 1:
 
{{DISPLAYTITLE:I2Rest API Implementation process}}
 
{{DISPLAYTITLE:I2Rest API Implementation process}}
<span style="color:red">i2Rest Server использует формат PCML как основу для описания параметров вызова программ IBM i и expose them as OpenAPI services. Формат PCML подробно описан [https://www.ibm.com/support/knowledgecenter/ssw_ibm_i_73/rzahh/pcml.htm on IBM site]. PCML описание ваших RPGLE программ может быть создано вручную в любом текстовом редакторе, или сгенерировано автоматически как результат выполнения команды CRTRPGMOD (параметры PGMINFO и INFOSTMF). i2Rest Server понимает все параметры PCML синтаксиса. В дополнении к стандартным, в i2Rest Server можно применять несколько расширенных атрибутов и тегов, направленных на улучшение взаимодействия клиента с вашими API</span>
+
In order to convert existing *PGM or *SRVPGM object to REST OAuth2 enabled web service, you have to complete following steps:
 +
 
 +
* Prepare file describing your program in [https://www.ibm.com/support/knowledgecenter/ssw_ibm_i_73/rzahh/pcml.htm PCML format]. You can do it manually or generate PCML automatically using CRTRPGMOD (PGMINFO and INFOSTMF fields)
 +
* (Optional) Enhance  PCML description with extended [I2Rest_PCML_syntax i2Rest PCML attributes and tags]
 +
* Publish PCML description to i2Rest Server using ADD_PCML API or add it to i2Rest Server Configuration file
 +
 
 +
You don't have to do any changes in your RPGLE code, existing programs can still untouched.

Revision as of 14:43, 22 May 2020

In order to convert existing *PGM or *SRVPGM object to REST OAuth2 enabled web service, you have to complete following steps:

  • Prepare file describing your program in PCML format. You can do it manually or generate PCML automatically using CRTRPGMOD (PGMINFO and INFOSTMF fields)
  • (Optional) Enhance PCML description with extended [I2Rest_PCML_syntax i2Rest PCML attributes and tags]
  • Publish PCML description to i2Rest Server using ADD_PCML API or add it to i2Rest Server Configuration file

You don't have to do any changes in your RPGLE code, existing programs can still untouched.