Mobinets-JIRA http://jira.mobinets.com/jira This file is an XML representation of an issue en-us 6.1.4 6159 19-11-2013 [ACE-7] TM Forum Open APIs http://jira.mobinets.com/jira/browse/ACE-7 ACE <ul class="alternate" type="square"> <li>Discover and search the APIs, list the useful ones</li> <li>Skeleton for the code</li> </ul> ACE-7 TM Forum Open APIs Story Normal To Do Unresolved Unassigned Ahmed Osman Mon, 22 Apr 2024 07:56:18 +0300 Mon, 15 Jun 2026 06:20:36 +0300 Mon, 29 Apr 2024 00:00:00 +0300 0 1 <p><b>Generating SpringBoot Server Code</b></p> <p><b>Option 1: Installing OpenAPI Generator CLI</b></p> <p>1. Install the OpenAPI Generator CLI:</p> <ul class="alternate" type="square"> <li>macOS/Linux: <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <pre class="code-java">brew install openapi-generator</pre> </div></div></li> <li>Using npm (Node.js): <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <pre class="code-java">npm install @openapitools/openapi-generator-cli -g</pre> </div></div></li> </ul> <p><b>Command</b></p> <p>Run the following command using the installed CLI:</p> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <pre class="code-java"> openapi-generator-cli generate \ -i /local/api-spec.yaml \ -g spring \ -o /local/out/spring \ -p generateApiTests=<span class="code-keyword">true</span> \ -p generateModelTests=<span class="code-keyword">true</span> \ -p interfaceOnly=<span class="code-keyword">false</span> \ -p delegatePattern=<span class="code-keyword">true</span> \ --additional-properties="\ groupId=com.nettom.tmfXXX,\ artifactId=tmfXXX-api,\ artifactVersion=v4,\ springBootVersion=2.7.18,\ java8=<span class="code-keyword">true</span>,\ basePackage=com.nettom.tmfXXX.v4,\ apiPackage=com.nettom.tmfXXX.v4.api,\ modelPackage=com.nettom.tmfXXX.v4.model,\ configPackage=com.nettom.tmfXXX.v4.config\ " </pre> </div></div> <p><b>Additional Instructions</b><br/> Make sure to replace the following values in the command <b>for both Option 1 and Option 2</b>:</p> <p>1. <b>API Specification File</b></p> <ul class="alternate" type="square"> <li>In the second line, replace <b>api-spec.yaml</b> with the correct TMF API specification file.</li> <li>Example:</li> <li>Go to <b>ACE 8 - TMF642</b> and download the Raw JSON API.</li> <li>Save the file. The default name will be something like: <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <pre class="code-java">TMF642_Alarm_Management_API_v4.0.0_swagger.json</pre> </div></div></li> <li>Update the second line of the command: <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <pre class="code-java">-i /local/api-spec.yaml</pre> </div></div> <p> to: </p> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <pre class="code-java">-i /local/TMF642_Alarm_Management_API_v4.0.0_swagger.json</pre> </div></div></li> </ul> <p>2. <b>Replace TMF Number</b></p> <ul class="alternate" type="square"> <li>Replace <b>tmfXXX</b> in the <b>groupId</b> or <b>artifactId</b> properties with the correct TMF number for your API (e.g., <b>tmf642</b>).</li> </ul> <p>3. <b>API Version</b></p> <ul class="alternate" type="square"> <li>If you have a newer version (e.g., <b>v5</b>), update the references from <b>v4</b> to <b>v5</b> in the <b>filename</b> and <b>artifactVersion</b>.</li> </ul> <p><b>Option 2 (Using Docker)</b><br/> If you have Docker installed, you can use the following command:</p> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <pre class="code-java"> docker run --rm \ -v <span class="code-quote">"$PWD:/local"</span> \ openapitools/openapi-generator-cli generate \ -i /local/api-spec.yaml \ -g spring \ -o /local/out/spring \ -p generateApiTests=<span class="code-keyword">true</span> \ -p generateModelTests=<span class="code-keyword">true</span> \ -p interfaceOnly=<span class="code-keyword">false</span> \ -p delegatePattern=<span class="code-keyword">true</span> \ --additional-properties="\ groupId=com.nettom.tmfXXX,\ artifactId=tmfXXX-api,\ artifactVersion=v4,\ springBootVersion=2.7.18,\ java8=<span class="code-keyword">true</span>,\ basePackage=com.nettom.tmfXXX.v4,\ apiPackage=com.nettom.tmfXXX.v4.api,\ modelPackage=com.nettom.tmfXXX.v4.model,\ configPackage=com.nettom.tmfXXX.v4.config\ " </pre> </div></div> <p><b>Note:</b> Follow the same Additional Instructions for this option to replace the API specification file, TMF number, and version appropriately.</p> Blocks ACE-8 ACE-9 ACE-10 ACE-11 ACE-12 ACE-13 ACE-14 ACE-15 ACE-16 ACE-17 ACE-18 ACE-19 ACE-20 ACE-21 ACE-22 Customer Dev. Actual Duration Gantt Options Last Comment <p style="display:inline"><b>Evaluation License Error:</b> EXPIRED</p> Original Estimate PDM Actual Duration Planned End Mon, 29 Apr 2024 00:00:00 +0300 Planned Start Mon, 29 Apr 2024 00:00:00 +0300 Rank 0|xti941: Rank (Obsolete) 9223372036854775807 VTDirections