I2Rest API Implementation - Revision history

Alexei.baranov at 13:34, 12 July 2020

2020-07-12T13:34:34Z

Alexei.baranov at 19:15, 26 June 2020

2020-06-26T19:15:35Z

Alexei.baranov at 08:45, 15 June 2020

2020-06-15T08:45:58Z

Alexei.baranov at 13:23, 25 May 2020

2020-05-25T13:23:55Z

Alexei.baranov at 11:46, 22 May 2020

2020-05-22T11:46:36Z

Alexei.baranov at 11:44, 22 May 2020

2020-05-22T11:44:44Z

Alexei.baranov at 11:43, 22 May 2020

2020-05-22T11:43:54Z

Alexei.baranov at 11:43, 22 May 2020

2020-05-22T11:43:29Z

Alexei.baranov: Created page with "{{DISPLAYTITLE:I2Rest API Implementation process}} i2Rest Server использует формат PCML как основу для описания п..."

2020-05-22T11:31:47Z

Created page with "{{DISPLAYTITLE:I2Rest API Implementation process}} <span style="color:red">i2Rest Server использует формат PCML как основу для описания п..."

New page

{{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>

← Older revision		Revision as of 13:34, 12 July 2020
Line 16:		Line 16:

	The specification file for this PCML will be available at:		The specification file for this PCML will be available at:
−	<pre>http(s)://<your_i2rest_server_main_gate>/openapi30/<mount_point></pre>	+	OpenAPI 3.0 format: <pre>http(s)://<your_i2rest_server_main_gate>/openapi30/<mount_point></pre>
		+	Swagger 2.0 format: <pre>http(s)://<your_i2rest_server_main_gate>/swagger20/<mount_point></pre>

← Older revision		Revision as of 19:15, 26 June 2020
Line 1:		Line 1:
−	{{DISPLAYTITLE:~~I2Rest~~ API Implementation process}}	+	{{DISPLAYTITLE:i2Rest API Implementation process}}
	In order to convert existing PGM or SRVPGM object to REST OAuth2 enabled web service, you have to complete following steps:		In order to convert existing PGM or SRVPGM object to REST OAuth2 enabled web service, you have to complete following steps:

@@ Line 2: / Line 2: @@
 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)
+# 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]]
+# (Optional) Enhance  PCML description with extended [[I2Rest_PCML_syntax|i2Rest PCML attributes and tags]]
-* Publish PCML description to i2Rest Server using [[Management_APIs#ADD_PCML_API|ADD_PCML API]] or add it to [[I2Rest_Config#pcmls|i2Rest Server Configuration file]]
+# Publish PCML description to i2Rest Server using [[Management_APIs#ADD_PCML_API|ADD_PCML API]] or add it to [[I2Rest_Config#pcmls|i2Rest Server Configuration file]]
 You don't have to do any changes in your RPGLE code, existing programs can still untouched.

← Older revision		Revision as of 13:23, 25 May 2020
Line 7:		Line 7:

	You don't have to do any changes in your RPGLE code, existing programs can still untouched.		You don't have to do any changes in your RPGLE code, existing programs can still untouched.
		+
		+	Upon deployment, you will be able to call all RPGLE programs described in some PCML file as an APIs at following URL:
		+	<pre>http(s)://<your_i2rest_server_main_gate>/<mount_point>/<program_name></pre>
		+	Where:
		+	* your_i2rest_server_main_gate - name and optional port of i2Rest Server's main gate
		+	* <div id="mount_point></div>mount_point - common mount point name for all programs in this PCML
		+	* program_name - value of 'name' attribute of program as described in PCML
		+
		+	The specification file for this PCML will be available at:
		+	<pre>http(s)://<your_i2rest_server_main_gate>/openapi30/<mount_point></pre>

@@ Line 4: / Line 4: @@
 * 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 [[Management_APIs#ADD_PCML_API|ADD_PCML API]] or add it to i2Rest Server Configuration file
+* Publish PCML description to i2Rest Server using [[Management_APIs#ADD_PCML_API|ADD_PCML API]] or add it to [[I2Rest_Config#pcmls|i2Rest Server Configuration file]]
 You don't have to do any changes in your RPGLE code, existing programs can still untouched.

← Older revision		Revision as of 11:43, 22 May 2020
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.