rapipdf 2.1.1 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (173) hide show
  1. package/README.md +66 -14
  2. package/dist/chunks/generate-BQLGaRvK.js +386 -0
  3. package/dist/chunks/generate-BQLGaRvK.js.LICENSE.txt +224 -0
  4. package/dist/chunks/localize-CRvDVkIz.js +8 -0
  5. package/dist/node.js +13096 -0
  6. package/dist/node.js.LICENSE.txt +195 -0
  7. package/dist/rapipdf-min.js +352 -90
  8. package/dist/rapipdf-min.js.LICENSE.txt +224 -0
  9. package/dist/rapipdf.js +69 -0
  10. package/package.json +58 -52
  11. package/src/node.d.ts +82 -0
  12. package/src/rapipdf.d.ts +50 -0
  13. package/.babelrc +0 -11
  14. package/.eslintrc +0 -28
  15. package/dist/index.html +0 -48
  16. package/dist/index.html.gz +0 -0
  17. package/dist/rapipdf-min.js.gz +0 -0
  18. package/dist/rapipdf-min.js.map +0 -1
  19. package/dist/rapipdf-min.js.map.gz +0 -0
  20. package/dist/report.html +0 -67
  21. package/docs/examples/example1.html +0 -68
  22. package/docs/examples/list.html +0 -27
  23. package/docs/examples/rapidoc-regular.woff2 +0 -0
  24. package/docs/examples/rapidoc-semi-bold.woff2 +0 -0
  25. package/docs/examples/roboto-mono-bold.woff2 +0 -0
  26. package/docs/examples/roboto-mono-regular.woff2 +0 -0
  27. package/docs/highlight/CHANGES.md +0 -1803
  28. package/docs/highlight/LICENSE +0 -24
  29. package/docs/highlight/README.md +0 -188
  30. package/docs/highlight/README.ru.md +0 -142
  31. package/docs/highlight/highlight.pack.js +0 -2
  32. package/docs/highlight/styles/a11y-dark.css +0 -99
  33. package/docs/highlight/styles/a11y-light.css +0 -99
  34. package/docs/highlight/styles/agate.css +0 -108
  35. package/docs/highlight/styles/an-old-hope.css +0 -89
  36. package/docs/highlight/styles/androidstudio.css +0 -66
  37. package/docs/highlight/styles/arduino-light.css +0 -88
  38. package/docs/highlight/styles/arta.css +0 -73
  39. package/docs/highlight/styles/ascetic.css +0 -45
  40. package/docs/highlight/styles/atelier-cave-dark.css +0 -83
  41. package/docs/highlight/styles/atelier-cave-light.css +0 -85
  42. package/docs/highlight/styles/atelier-dune-dark.css +0 -69
  43. package/docs/highlight/styles/atelier-dune-light.css +0 -69
  44. package/docs/highlight/styles/atelier-estuary-dark.css +0 -84
  45. package/docs/highlight/styles/atelier-estuary-light.css +0 -84
  46. package/docs/highlight/styles/atelier-forest-dark.css +0 -69
  47. package/docs/highlight/styles/atelier-forest-light.css +0 -69
  48. package/docs/highlight/styles/atelier-heath-dark.css +0 -69
  49. package/docs/highlight/styles/atelier-heath-light.css +0 -69
  50. package/docs/highlight/styles/atelier-lakeside-dark.css +0 -69
  51. package/docs/highlight/styles/atelier-lakeside-light.css +0 -69
  52. package/docs/highlight/styles/atelier-plateau-dark.css +0 -84
  53. package/docs/highlight/styles/atelier-plateau-light.css +0 -84
  54. package/docs/highlight/styles/atelier-savanna-dark.css +0 -84
  55. package/docs/highlight/styles/atelier-savanna-light.css +0 -84
  56. package/docs/highlight/styles/atelier-seaside-dark.css +0 -69
  57. package/docs/highlight/styles/atelier-seaside-light.css +0 -69
  58. package/docs/highlight/styles/atelier-sulphurpool-dark.css +0 -69
  59. package/docs/highlight/styles/atelier-sulphurpool-light.css +0 -69
  60. package/docs/highlight/styles/atom-one-dark-reasonable.css +0 -77
  61. package/docs/highlight/styles/atom-one-dark.css +0 -96
  62. package/docs/highlight/styles/atom-one-light.css +0 -96
  63. package/docs/highlight/styles/brown-paper.css +0 -64
  64. package/docs/highlight/styles/brown-papersq.png +0 -0
  65. package/docs/highlight/styles/codepen-embed.css +0 -60
  66. package/docs/highlight/styles/color-brewer.css +0 -71
  67. package/docs/highlight/styles/darcula.css +0 -77
  68. package/docs/highlight/styles/dark.css +0 -63
  69. package/docs/highlight/styles/darkula.css +0 -6
  70. package/docs/highlight/styles/default.css +0 -99
  71. package/docs/highlight/styles/docco.css +0 -97
  72. package/docs/highlight/styles/dracula.css +0 -76
  73. package/docs/highlight/styles/far.css +0 -71
  74. package/docs/highlight/styles/foundation.css +0 -88
  75. package/docs/highlight/styles/github-gist.css +0 -71
  76. package/docs/highlight/styles/github.css +0 -99
  77. package/docs/highlight/styles/gml.css +0 -78
  78. package/docs/highlight/styles/googlecode.css +0 -89
  79. package/docs/highlight/styles/grayscale.css +0 -101
  80. package/docs/highlight/styles/gruvbox-dark.css +0 -108
  81. package/docs/highlight/styles/gruvbox-light.css +0 -108
  82. package/docs/highlight/styles/hopscotch.css +0 -83
  83. package/docs/highlight/styles/hybrid.css +0 -102
  84. package/docs/highlight/styles/idea.css +0 -97
  85. package/docs/highlight/styles/ir-black.css +0 -73
  86. package/docs/highlight/styles/isbl-editor-dark.css +0 -112
  87. package/docs/highlight/styles/isbl-editor-light.css +0 -112
  88. package/docs/highlight/styles/kimbie.dark.css +0 -74
  89. package/docs/highlight/styles/kimbie.light.css +0 -74
  90. package/docs/highlight/styles/lightfair.css +0 -87
  91. package/docs/highlight/styles/magula.css +0 -70
  92. package/docs/highlight/styles/mono-blue.css +0 -59
  93. package/docs/highlight/styles/monokai-sublime.css +0 -83
  94. package/docs/highlight/styles/monokai.css +0 -70
  95. package/docs/highlight/styles/nord.css +0 -309
  96. package/docs/highlight/styles/obsidian.css +0 -88
  97. package/docs/highlight/styles/ocean.css +0 -74
  98. package/docs/highlight/styles/paraiso-dark.css +0 -72
  99. package/docs/highlight/styles/paraiso-light.css +0 -72
  100. package/docs/highlight/styles/pojoaque.css +0 -83
  101. package/docs/highlight/styles/pojoaque.jpg +0 -0
  102. package/docs/highlight/styles/purebasic.css +0 -96
  103. package/docs/highlight/styles/qtcreator_dark.css +0 -83
  104. package/docs/highlight/styles/qtcreator_light.css +0 -83
  105. package/docs/highlight/styles/railscasts.css +0 -106
  106. package/docs/highlight/styles/rainbow.css +0 -85
  107. package/docs/highlight/styles/routeros.css +0 -108
  108. package/docs/highlight/styles/school-book.css +0 -72
  109. package/docs/highlight/styles/school-book.png +0 -0
  110. package/docs/highlight/styles/shades-of-purple.css +0 -97
  111. package/docs/highlight/styles/solarized-dark.css +0 -84
  112. package/docs/highlight/styles/solarized-light.css +0 -84
  113. package/docs/highlight/styles/sunburst.css +0 -102
  114. package/docs/highlight/styles/tomorrow-night-blue.css +0 -75
  115. package/docs/highlight/styles/tomorrow-night-bright.css +0 -74
  116. package/docs/highlight/styles/tomorrow-night-eighties.css +0 -74
  117. package/docs/highlight/styles/tomorrow-night.css +0 -75
  118. package/docs/highlight/styles/tomorrow.css +0 -72
  119. package/docs/highlight/styles/vs.css +0 -68
  120. package/docs/highlight/styles/vs2015.css +0 -115
  121. package/docs/highlight/styles/xcode.css +0 -104
  122. package/docs/highlight/styles/xt256.css +0 -92
  123. package/docs/highlight/styles/zenburn.css +0 -80
  124. package/docs/images/console.svg +0 -12
  125. package/docs/images/dark_ss.png +0 -0
  126. package/docs/images/easy.svg +0 -14
  127. package/docs/images/fast.svg +0 -8
  128. package/docs/images/gears.svg +0 -11
  129. package/docs/images/light_ss.png +0 -0
  130. package/docs/images/logo.png +0 -0
  131. package/docs/images/love.svg +0 -8
  132. package/docs/images/mask.svg +0 -16
  133. package/docs/images/mouse.svg +0 -7
  134. package/docs/images/pdf_sample1.png +0 -0
  135. package/docs/images/pdf_sample2.png +0 -0
  136. package/docs/images/webcomponent.svg +0 -13
  137. package/docs/index.css +0 -254
  138. package/docs/index.html +0 -376
  139. package/docs/rapipdf-min.js +0 -95
  140. package/docs/specs/allof-primitives.json +0 -80
  141. package/docs/specs/allof.json +0 -73
  142. package/docs/specs/anyof.json +0 -84
  143. package/docs/specs/basic.json +0 -75
  144. package/docs/specs/bitbucket.json +0 -12916
  145. package/docs/specs/data-types.yaml +0 -168
  146. package/docs/specs/gcloud.json +0 -1347
  147. package/docs/specs/no-server.json +0 -1
  148. package/docs/specs/oneof.json +0 -64
  149. package/docs/specs/petstore.json +0 -1042
  150. package/docs/specs/petstore_extended.yaml +0 -889
  151. package/docs/specs/temp.json +0 -53
  152. package/docs/specs/test-specs/large-models.json +0 -5998
  153. package/docs/specs/test-specs/long-descriptions.json +0 -5443
  154. package/docs/specs/test-specs/long-paths.json +0 -9562
  155. package/docs/specs/test-specs/oneof-allof-nested.yaml +0 -105
  156. package/docs/specs/test-specs/partial-spec-main.json +0 -29
  157. package/docs/specs/test-specs/partial.json +0 -17
  158. package/docs/specs/test-specs/petstore_complex_request.yaml +0 -335
  159. package/docs/specs/test-specs/petstore_experimental.yaml +0 -167
  160. package/docs/specs/test-specs/xxx-of-with-primitives-and-recursive-model.yaml +0 -952
  161. package/docs/welcome.html +0 -369
  162. package/index.html +0 -48
  163. package/logo.png +0 -0
  164. package/src/index.js +0 -3
  165. package/src/markdown.js +0 -120
  166. package/src/object-tree-gen.js +0 -370
  167. package/src/pdf-gen.js +0 -113
  168. package/src/pdf-parts-gen.js +0 -488
  169. package/src/rapipdf.js +0 -246
  170. package/src/spec-parser.js +0 -162
  171. package/src/table-layouts.js +0 -35
  172. package/src/vfs_fonts.js +0 -7
  173. package/webpack.config.js +0 -118
package/docs/index.css DELETED
@@ -1,254 +0,0 @@
1
- body{
2
- font-family: 'Varela Round', sans-serif;
3
- font-size: 14px;
4
- line-height: 24px;
5
- color: #333;
6
- font-weight: 500;
7
- background: #fff;
8
- margin: 0;
9
- display: block;
10
- }
11
- a{ color:navy;}
12
- code{ font-family: 'Roboto Mono', monospace;}
13
-
14
- .banner {
15
- padding: 60px 16px;
16
- background: #b44646;
17
- color: #fff;
18
- text-align: center;
19
- font-family: 'Varela Round', sans-serif;
20
- }
21
- .banner-title {
22
- font-size: 38px;
23
- line-height: 48px;
24
- font-weight: 800;
25
- transition: .3s all;
26
- }
27
- .header {
28
- display: flex;
29
- align-items: center;
30
- height: 60px;
31
- justify-content: center;
32
- }
33
-
34
- .logo{display:none}
35
- .menu{display:none}
36
- .code-block{
37
- font-size:12px;
38
- width:320px;
39
- }
40
- .table-block{
41
- font-size:12px;
42
- width:350px;
43
- }
44
-
45
- .menu-item {
46
- margin-right: 12px;
47
- color: #fff;
48
- font-weight: 600;
49
- text-decoration: none;
50
- transition: .2s all;
51
- position: relative;
52
- }
53
-
54
- .product-name {
55
- font-family:"Roboto Mono";
56
- font-weight: 800;
57
- font-size: 36px;
58
- line-height: 40px;
59
- color: #fff;
60
- transition: .3s all;
61
- min-width: 225px;
62
- }
63
-
64
-
65
- .features,
66
- .qstart,
67
- .feature-list,
68
- .examples,
69
- .api,
70
- .footer {
71
- display:flex;
72
- flex-wrap:wrap;
73
- justify-content: center;
74
- min-height:150px;
75
- }
76
-
77
- .examples,
78
- .qstart {
79
- background-color: #deb0b0;
80
- }
81
- .footer{
82
- background-color: #444;
83
- color:#ccc;
84
- }
85
-
86
-
87
- .footer-item{
88
- padding: 5px 16px;
89
- }
90
- .footer-item a{
91
- color:#ccc;
92
- }
93
-
94
- .feature-list{
95
- text-align: left;
96
- }
97
-
98
-
99
- .container{
100
- padding: 40px 64px;
101
- font-family: 'Varela Round', sans-serif;
102
- }
103
-
104
-
105
- .feature{
106
- display:flex;
107
- flex:1;
108
- max-width:320px;
109
- min-width:320px;
110
- margin:0 8px 24px 8px;
111
- }
112
-
113
- .feature-icon{
114
- min-width:64px;
115
- min-height:64px;
116
- }
117
-
118
- .feature-info{
119
- display:flex;
120
- flex-direction: column;
121
- margin-left:12px;
122
- text-align:left;
123
- font-size:16px;
124
- }
125
-
126
- .feature-info .feature-title{ font-size:18px;}
127
- .feature-info .feature-descr{ font-size:14px;}
128
-
129
- .screenshot{
130
- max-width:350px;
131
- border-radius: 4px;
132
- height:auto;
133
- width:auto
134
- }
135
-
136
- .shadow1 {
137
- box-shadow: 0 2px 2px rgba(0,0,0,0.25);
138
- }
139
- .shadow2{
140
- box-shadow: 0 2px 3px rgba(100,100,100,0.12), 0 2px 3px rgba(100,100,100,0.24);
141
-
142
- }
143
- .shadow3 {
144
- box-shadow: 0 12px 24px rgba(0,0,0,0.25), 0 6px 6px rgba(0,0,0,0.22);
145
- }
146
-
147
- .mono-bold{
148
- font-family:"Roboto Mono";
149
- font-weight:700;
150
- text-align: right;
151
- }
152
- .gray{
153
- color:#777;
154
- }
155
-
156
- .m-table {
157
- border-spacing: 0;
158
- border-collapse: separate;
159
- border: 1px solid #ccc;
160
- border-radius: 2px;
161
- margin: 0;
162
- }
163
- .attr-col{
164
- width:100px;
165
- text-align:right
166
- }
167
- .default-col{
168
- width:70px;
169
- text-align:left;
170
- }
171
-
172
- .m-table tr:first-child td,
173
- .m-table tr:first-child th {
174
- border-top: 0 none;
175
- }
176
-
177
- .m-table th {
178
- color: #565656;
179
- font-size: 12px;
180
- line-height: 30px;
181
- font-weight: 600;
182
- letter-spacing: normal;
183
- background-color: #fafafa;
184
- vertical-align: bottom;
185
- border-bottom: 1px solid #ccc;
186
- }
187
-
188
- .m-table td,
189
- .m-table th {
190
- padding: 4px 5px 4px;
191
- vertical-align: top;
192
- border-bottom:1px solid #eee;
193
- }
194
- .m-table th{
195
- border-bottom:1px solid #aaa;
196
- }
197
-
198
- @media only screen and (min-width: 768px){
199
- .header { justify-content:left }
200
- .menu { display:inline-block; }
201
- .logo { display:block; }
202
- .code-block{
203
- font-size:12px;
204
- width:650px;
205
- }
206
- .table-block{
207
- font-size:12px;
208
- width:650px;
209
- }
210
- .attr-col{ width:180px;}
211
- .default-col{ width:130px;}
212
-
213
-
214
- .menu-item {
215
- margin-left: 20px;
216
- margin-right: 0;
217
- }
218
- .banner {
219
- padding: 80px 32px;
220
- }
221
- .features {
222
- padding: 80px 32px;
223
- }
224
-
225
- .features {
226
- padding-top: 80px;
227
- padding-bottom: 80px;
228
- }
229
- .demo {
230
- padding-top: 80px;
231
- padding-bottom: 80px;
232
- }
233
- .screenshot{
234
- max-width:750px;
235
- }
236
- }
237
-
238
- @media only screen and (min-width: 800px){
239
- .menu { display:inline-block; }
240
- .logo { display:block; }
241
- .code-block{
242
- font-size:14px;
243
- width:730px;
244
- }
245
- .table-block{
246
- font-size:14px;
247
- width:730px;
248
- }
249
- .menu-item {
250
- margin-left: 24px;
251
- margin-right: 0;
252
- }
253
- }
254
-
package/docs/index.html DELETED
@@ -1,376 +0,0 @@
1
- <!doctype html>
2
-
3
- <head>
4
- <meta charset="utf-8">
5
- <meta name="viewport" content="width=device-width, minimum-scale=1, initial-scale=1, user-scalable=yes">
6
- <meta name="description" content="RapiPdf is Web Component based Swagger & OpenAPI Spec to PDF generator">
7
- <meta name="keywords" content="RapiPdf, RapiDoc, ReDoc, Swagger, SwaggerUI, Custom Element, Web Component, OpenAPI, REST">
8
-
9
- <link rel="shortcut icon" type="image/png" href="./images/logo.png"/>
10
-
11
- <!-- Global site tag (gtag.js) - Google Analytics -->
12
- <script async src="https://www.googletagmanager.com/gtag/js?id=UA-132775238-2"></script>
13
- <script>
14
- window.dataLayer = window.dataLayer || [];
15
- function gtag(){dataLayer.push(arguments);}
16
- gtag('js', new Date());
17
-
18
- gtag('config', 'UA-132775238-2');
19
- </script>
20
-
21
- <!-- Fonts -->
22
- <link href="https://fonts.googleapis.com/css?family=Roboto+Mono:400,700" rel="stylesheet">
23
- <link href="https://fonts.googleapis.com/css?family=Varela+Round" rel="stylesheet">
24
-
25
- <!-- Code Highlight -->
26
- <link rel="stylesheet" href="./highlight/styles/zenburn.css">
27
- <script src="./highlight/highlight.pack.js"></script>
28
- <script>hljs.initHighlightingOnLoad();</script>
29
-
30
- <script type="text/javascript" src="rapipdf-min.js" defer></script>
31
-
32
- <link rel="stylesheet" href="index.css">
33
-
34
- <title>RapiPDF - Web Component based Swagger & OpenAPI PDF Generator</title>
35
- </head>
36
-
37
- <body>
38
- <div class="banner container" id="banner">
39
- <div class="header">
40
- <img class="logo" src="./images/logo.png" style="width:48px;height:48px;margin-right:10px;" />
41
- <div class="product-name">&lt;rapi-pdf&gt;</div>
42
- <div class="menu" style="flex:1"></div>
43
- <nav class="menu" onclick="goToSection(event)">
44
- <a class="menu-item" href="#features"> Features </a>
45
- <a class="menu-item" href="#qstart"> Quick Start </a>
46
- <a class="menu-item" href="#api"> API </a>
47
- <a class="menu-item" data-action="url" href="https://mrin9.github.io/RapiDoc/"> RapiDoc </a>
48
- <a class="menu-item" data-action="git" href="https://github.com/mrin9/RapiPdf"> GitHub </a>
49
- </nav>
50
- </div>
51
- <div>
52
- <div class="banner-content">
53
- <h1 class="banner-title">Web Component to generate PDF from OpenAPI Spec</h1>
54
- <div class="banner-content-inner">
55
- <p style="font-size:18px">Create beautiful, customizable API documentation in PDF format from your OpenAPI Specification</p>
56
- </div>
57
- </div>
58
- </div>
59
- <div style="display:flex; justify-content: center;">
60
- <div style="display:block">
61
- <img class="screenshot shadow3" src="./images/pdf_sample1.png" />
62
- </div>
63
- </div>
64
- </div>
65
- <div class="features container" id="features">
66
-
67
- <div class="feature">
68
- <object type="image/svg+xml" data="./images/webcomponent.svg" style="width:64px; height:64px;"> </object>
69
- <div class="feature-info">
70
- <div class="feature-title"> Web Component Standard</div>
71
- <div class="feature-descr">
72
- Free of any frameworks, setups, configs, build steps or packaging.
73
- Can be used with any framework or just with vanilla javascript
74
- </div>
75
- </div>
76
- </div>
77
-
78
- <div class="feature">
79
- <object type="image/svg+xml" data="./images/easy.svg" style="width:64px; height:64px;"> </object>
80
- <div class="feature-info">
81
- <div class="feature-title"> Easy Usage</div>
82
- <div class="feature-descr">
83
- Use It just like any other HTML Tag, use its various attributes to customize the generation of your PDF.
84
- Basic knowledge of HTML is all that's required
85
- </div>
86
- </div>
87
- </div>
88
-
89
- <div class="feature">
90
- <object type="image/svg+xml" data="./images/mask.svg" style="width:64px; height:64px;"> </object>
91
- <div class="feature-info">
92
- <div class="feature-title">Customizable</div>
93
- <div class="feature-descr">
94
- Change font colors to match your brand colors.
95
- Pick and choose the sections from the API Spec that you want to include in the PDF.
96
- </div>
97
- </div>
98
- </div>
99
-
100
- <div class="feature">
101
- <object type="image/svg+xml" data="./images/gears.svg" style="width:64px; height:64px;"> </object>
102
- <div class="feature-info">
103
- <div class="feature-title"> Seamlessly interoperable</div>
104
- <div class="feature-descr">
105
- Loved by tech writers, designers, dev-ops, testers and developers alike,
106
- due to its simplicity, interoperability and powerful features.
107
- </div>
108
- </div>
109
- </div>
110
-
111
- </div>
112
-
113
- <div id="qstart" class="qstart container">
114
- <div style="display:flex; flex-direction: column; ">
115
- <h2> Quickstart & Demo</h2>
116
- Just copy the below code and save it in an html file. Then open it using a browser
117
-
118
- <pre class="shadow code-block"><code class="html" style="border-radius:4px">
119
- &lt;!doctype html&gt;
120
- &lt;html&gt;
121
- &lt;head&gt;
122
- &lt;script src="https://unpkg.com/rapipdf/dist/rapipdf-min.js"&gt;&lt;/script&gt;
123
- &lt;/head&gt;
124
- &lt;body&gt;
125
- &lt;rapi-pdf
126
- style = "width:700px; height:40px; font-size:18px;"
127
- spec-url = "https://mrin9.github.io/RapiPdf/specs/petstore.json"
128
- button-bg = "#b44646"
129
- &gt; &lt;/rapi-pdf&gt;
130
- &lt;/body&gt;
131
- &lt;/html&gt;
132
- </code></pre>
133
-
134
- <div> Go ahead, provide your Open API spec and click GENERATE PDF !!! </div>
135
- <rapi-pdf id='rapipdf' style="width:730px; height:40px; font-size:18px;"
136
- spec-url="https://mrin9.github.io/RapiPdf/specs/petstore.json"
137
- button-bg="#b44646"
138
- pdf-title="API Reference"
139
- > </rapi-pdf>
140
-
141
- <div style="margin-top:16px;"> With different Color scheme </div>
142
- <rapi-pdf id='rapipdf' style="width:730px; height:40px; font-size:18px;"
143
- spec-url="https://mrin9.github.io/RapiPdf/specs/petstore.json"
144
- pdf-schema-style="table"
145
- button-bg="#b44646"
146
- pdf-primary-color="teal",
147
- pdf-alternate-color="darkred"
148
- pdf-title="API Reference"
149
- > </rapi-pdf>
150
-
151
- <div style="margin-top:16px;"> With an alternate request/response model represnation style </div>
152
- <rapi-pdf id='rapipdf' style="width:730px; height:40px; font-size:18px;"
153
- spec-url="https://mrin9.github.io/RapiPdf/specs/petstore.json"
154
- pdf-schema-style="table"
155
- button-bg="#b44646"
156
- pdf-title="API Reference"
157
- > </rapi-pdf>
158
-
159
-
160
- </div>
161
- </div>
162
-
163
- <!-- Start of API -->
164
- <div class="api container" id="api">
165
- <div style="display:flex; flex-direction: column; ">
166
- <h2> Attributes</h2>
167
- <div class="table-block">
168
- <table class="m-table">
169
- <tr>
170
- <th class="attr-col">Attribute</th>
171
- <th style="text-align:left">Description </th>
172
- <th class="default-col">Default</th>
173
- </tr>
174
-
175
- <tr>
176
- <td class="mono-bold">spec-url </td>
177
- <td class="gray">url of the OpenAPI spec to view </td>
178
- <td>(empty)</td>
179
- </tr>
180
-
181
- <tr>
182
- <td class="mono-bold">button-label</td>
183
- <td class="gray"> Label on the Button</td>
184
- <td>GENERATE PDF</td>
185
- </tr>
186
-
187
- <tr>
188
- <td class="mono-bold">button-bg</td>
189
- <td class="gray">Background color for the button</td>
190
- <td>#0078d7</td>
191
- </tr>
192
-
193
- <tr>
194
- <td class="mono-bold">button-color</td>
195
- <td class="gray">Text color on the button</td>
196
- <td>white</td>
197
- </tr>
198
-
199
- <tr>
200
- <td class="mono-bold">input-bg</td>
201
- <td class="gray">Background color for text input</td>
202
- <td>white</td>
203
- </tr>
204
-
205
- <tr>
206
- <td class="mono-bold">input-color</td>
207
- <td class="gray">Text color of the input box</td>
208
- <td>#333</td>
209
- </tr>
210
-
211
- <tr>
212
- <td class="mono-bold">hide-input</td>
213
- <td class="gray"> true to hide input Text box </td>
214
- <td>false</td>
215
- </tr>
216
-
217
- <tr>
218
- <td class="mono-bold">pdf-primary-color</td>
219
- <td class="gray">Color used for headings of main sections in PDF</td>
220
- <td>#b44646</td>
221
- </tr>
222
-
223
- <tr>
224
- <td class="mono-bold">pdf-alternate-color</td>
225
- <td class="gray">Color used for sub headings</td>
226
- <td>#005b96</td>
227
- </tr>
228
-
229
- <tr>
230
- <td class="mono-bold">pdf-title</td>
231
- <td class="gray">Title of the generated PDF</td>
232
- <td>API Reference</td>
233
- </tr>
234
-
235
- <tr>
236
- <td class="mono-bold">pdf-footer-text</td>
237
- <td class="gray">Text to be printed at the bottom of every page</td>
238
- <td>(empty)</td>
239
- </tr>
240
-
241
- <tr>
242
- <td class="mono-bold">pdf-schema-style</td>
243
- <td class="gray">style to display request and response schemas<br/>can be 'table' or 'object'</td>
244
- <td>object</td>
245
- </tr>
246
-
247
- <tr>
248
- <td class="mono-bold">include-info</td>
249
- <td class="gray"> true to include info section in the generated PDF</td>
250
- <td>true</td>
251
- </tr>
252
-
253
- <tr>
254
- <td class="mono-bold">include-toc</td>
255
- <td class="gray">true to include table-of-contents in the generated PDF</td>
256
- <td>true</td>
257
- </tr>
258
-
259
- <tr>
260
- <td class="mono-bold">include-security</td>
261
- <td class="gray">true to include security section in the generated PDF</td>
262
- <td>true</td>
263
- </tr>
264
-
265
- <tr>
266
- <td class="mono-bold">include-example</td>
267
- <td class="gray">true to examples in the generated PDF (as of now it will NOT print request-body or response examples) </td>
268
- <td>false</td>
269
- </tr>
270
-
271
- <tr>
272
- <td class="mono-bold">include-api-details</td>
273
- <td class="gray">true to include all the API details in the generated PDF</td>
274
- <td>true</td>
275
- </tr>
276
-
277
- <tr>
278
- <td class="mono-bold">include-api-list</td>
279
- <td class="gray">true to include list of all the APIs and their summary at the end in the generated PDF </td>
280
- <td>false</td>
281
- </tr>
282
- </table>
283
- </div>
284
-
285
- <h2> Methods</h2>
286
- <div class="table-block">
287
- <table class="m-table">
288
- <tr>
289
- <th > Name</th>
290
- <th >Description </th>
291
- </tr>
292
- <tr>
293
- <td class="mono-bold">generatePdf(spec)</td>
294
- <td class="gray">
295
- to programmatically generate the PDF. <br/>
296
- Takes a single parameter that can be :
297
- <ul>
298
- <li> either a string containing the url of the specs</li>
299
- <li> or a JSON object representing a valid spec</li>
300
- </ul>
301
- <a href="https://github.com/mrin9/RapiPdf/blob/master/docs/examples/example1.html"> Example </a>
302
- </td>
303
- </tr>
304
- <tr>
305
- <td class="mono-bold">setAttribute(attr-name, value)</td>
306
- <td class="gray">All HTML elements contains setAttribute() method, You may use this method to programmatically update/change any of its properties</td>
307
- </tr>
308
- </table>
309
- </div>
310
-
311
- <h2> Localization</h2>
312
- <div class="mono-bold" style="text-align: center;">create a &lt;template&gt; inside &lt;rapi-pdf&gt; element and provide the translations</div>
313
- <pre class="shadow code-block"><code class="html" style="border-radius:4px">
314
- &lt;rapi-pdf spec-url="https://api.apis.guru/v2/specs/bitbucket.org/2.0/swagger.json"&gt;
315
- &lt;template&gt;
316
- {
317
- "index" : "INDEX",
318
- "api" : "API",
319
- "apiList" : "API List",
320
- "apiReference" : "API Reference",
321
- "apiVersion" : "API Version",
322
- "contact" : "CONTACT",
323
- "name" : "NAME",
324
- "email" : "EMAIL",
325
- "url" : "URL",
326
- "termsOfService" : "Terms of service",
327
- "securitySchemes": "SECURITY SCHEMES",
328
- "type" : "TYPE",
329
- "example" : "EXAMPLE",
330
- "description" : "DESCRIPTION",
331
- "request" : "REQUEST",
332
- "requestBody" : "REQUEST BODY",
333
- "response" : "RESPONSE",
334
- "responseModel" : "RESPONSE MODEL",
335
- "statusCode" : "STATUS CODE",
336
- "deprecated" : "DEPRECATED",
337
- "allowed" : "allowed",
338
- "pattern" : "pattern",
339
- "parameters" : "Parameters",
340
- "method" : "METHOD",
341
- "securityAndAuthentication" : "Security and Authentication",
342
- "noRequestParameters" : "No request parameters",
343
- }
344
- &lt;/template&gt;
345
- &lt;/rapi-pdf&gt;
346
- </code>
347
- </pre>
348
-
349
- </div>
350
- </div>
351
- <!-- End of API -->
352
-
353
- <div id="footer" class="footer container">
354
- <div class="footer-item"> MIT Licence</div>
355
- <div class="footer-item"> <a href="https://github.com/mrin9/RapiPdf"> GitHub</a></div>
356
- <div class="footer-item"> <a href="https://www.npmjs.com/package/rapipdf"> npm</a></div>
357
- </div>
358
-
359
-
360
- <script>
361
-
362
- function goToSection(e){
363
- if (e.target.dataset.action==='git' || e.target.dataset.action==='url' ){
364
- return;
365
- }
366
-
367
- e.preventDefault();
368
- var gotoEl = document.getElementById(e.target.getAttribute('href').substring(1));
369
- if (gotoEl){
370
- gotoEl.scrollIntoView({ block: 'start', behavior: 'smooth' });
371
- }
372
- }
373
- </script>
374
- </body>
375
-
376
- </html>