added localization feature

mrin9 · Sep 7, 2019 · 03728e9 · 03728e9
1 parent 28b18e4
commit 03728e9
Show file tree

Hide file tree

Showing 12 changed files with 249 additions and 13 deletions.
diff --git a/dist/index.html b/dist/index.html
@@ -0,0 +1,42 @@
+<!doctype html>
+<html lang="en">
+
+<head>
+ <meta name="viewport" content="width=device-width, minimum-scale=1, initial-scale=1, user-scalable=yes">
+ <title>RapiPdf</title>
+</head>
+
+<body>
+ <!-- 
+ Some sample spec to try
+ http://10.21.83.83:8080/api/swagger.json
+ https://api.apis.guru/v2/specs/stripe.com/2019-02-19/swagger.json 
+ https://api.apis.guru/v2/specs/github.com/v3/swagger.json
+ https://api.apis.guru/v2/specs/bitbucket.org/2.0/swagger.json
+ https://petstore.swagger.io/v2/swagger.json
+ https://assets.zuora.com/zuora-documentation/swagger.yaml <<< Large spec with lot of markdown
+ -->
+
+ <rapi-pdf id='rapipdf' style="width:750px; height:40px; font-size:18px"
+ spec-url="https://api.apis.guru/v2/specs/bitbucket.org/2.0/swagger.json" 
+ pdf-title="New API Reference"
+ >
+ <template>
+ { "index" : "Translated INDEX"}
+ </template>
+ </rapi-pdf>
+
+
+ <button onclick="changeSpec()">Change Spec</button>
+ <script type="text/javascript">
+ function changeSpec(){
+ let el = document.getElementById("rapipdf");
+ //el.specUrl = 'abcd'
+ el.setAttribute('spec-url', 'set new attrib');
+ } 
+ </script> 
+
+
+<script type="text/javascript" src="rapipdf-min.js"></script></body>
+
+</html>
diff --git a/dist/index.html.gz b/dist/index.html.gz
diff --git a/dist/rapipdf-min.js b/dist/rapipdf-min.js
diff --git a/dist/rapipdf-min.js.gz b/dist/rapipdf-min.js.gz
diff --git a/dist/rapipdf-min.js.map b/dist/rapipdf-min.js.map
diff --git a/dist/rapipdf-min.js.map.gz b/dist/rapipdf-min.js.map.gz
diff --git a/dist/report.html b/dist/report.html
diff --git a/docs/index.html b/docs/index.html
@@ -266,6 +266,44 @@ <h2> Methods</h2>
  </tr>
  </table>
  </div>
+
+ <h2> Localization</h2>
+ <div class="mono-bold" style="text-align: center;">create a &lt;template&gt; inside &lt;rapi-pdf&gt; element and provide the translations</div>
+ <pre class="shadow code-block"><code class="html" style="border-radius:4px">
+&lt;rapi-pdf spec-url="https://api.apis.guru/v2/specs/bitbucket.org/2.0/swagger.json"&gt;
+ &lt;template&gt;
+ {
+ "index" : "INDEX",
+ "api" : "API",
+ "apiList" : "API List",
+ "apiReference" : "API Reference",
+ "apiVersion" : "API Version",
+ "contact" : "CONTACT",
+ "name" : "NAME",
+ "email" : "EMAIL",
+ "url" : "URL",
+ "termsOfService" : "Terms of service",
+ "securitySchemes": "SECURITY SCHEMES",
+ "type" : "TYPE",
+ "description" : "DESCRIPTION",
+ "request" : "REQUEST",
+ "requestBody" : "REQUEST BODY",
+ "response" : "RESPONSE",
+ "responseModel" : "RESPONSE MODEL",
+ "statusCode" : "STATUS CODE",
+ "deprecated" : "DEPRECATED",
+ "allowed" : "allowed",
+ "pattern" : "pattern",
+ "parameters" : "Parameters",
+ "method" : "METHOD",
+ "securityAndAuthentication" : "Security and Authentication",
+ "noRequestParameters" : "No request parameters",
+ }
+ &lt;/template&gt;
+&lt;/rapi-pdf&gt;
+ </code>
+ </pre>
+
  </div> 
  </div>
  <!-- End of API -->
@@ -291,8 +329,6 @@ <h2> Methods</h2>
  }
  }
 
-
-
  </script>
 </body>
 

diff --git a/docs/rapipdf-min.js b/docs/rapipdf-min.js
diff --git a/docs/welcome.html b/docs/welcome.html
@@ -266,6 +266,44 @@ <h2> Methods</h2>
  </tr>
  </table>
  </div>
+
+ <h2> Localization</h2>
+ <div class="mono-bold" style="text-align: center;">create a &lt;template&gt; inside &lt;rapi-pdf&gt; element and provide the translations</div>
+ <pre class="shadow code-block"><code class="html" style="border-radius:4px">
+&lt;rapi-pdf spec-url="https://api.apis.guru/v2/specs/bitbucket.org/2.0/swagger.json"&gt;
+ &lt;template&gt;
+ {
+ "index" : "INDEX",
+ "api" : "API",
+ "apiList" : "API List",
+ "apiReference" : "API Reference",
+ "apiVersion" : "API Version",
+ "contact" : "CONTACT",
+ "name" : "NAME",
+ "email" : "EMAIL",
+ "url" : "URL",
+ "termsOfService" : "Terms of service",
+ "securitySchemes": "SECURITY SCHEMES",
+ "type" : "TYPE",
+ "description" : "DESCRIPTION",
+ "request" : "REQUEST",
+ "requestBody" : "REQUEST BODY",
+ "response" : "RESPONSE",
+ "responseModel" : "RESPONSE MODEL",
+ "statusCode" : "STATUS CODE",
+ "deprecated" : "DEPRECATED",
+ "allowed" : "allowed",
+ "pattern" : "pattern",
+ "parameters" : "Parameters",
+ "method" : "METHOD",
+ "securityAndAuthentication" : "Security and Authentication",
+ "noRequestParameters" : "No request parameters",
+ }
+ &lt;/template&gt;
+&lt;/rapi-pdf&gt;
+ </code>
+ </pre>
+
  </div> 
  </div>
  <!-- End of API -->

diff --git a/index.html b/index.html
@@ -22,7 +22,7 @@
  pdf-title="New API Reference"
  >
  <template>
- {"index":"Translated INDEX"}
+ { "index" : "Translated INDEX"}
  </template>
  </rapi-pdf>
 

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
  "name": "rapipdf",
- "version": "1.0.5",
+ "version": "1.1.0",
  "description": "RapiPdf - Generate PDF from Open API spec",
  "author": "Mrinmoy Majumdar <[email protected]>",
  "repository": {