Skip to content

Commit 8af2823

Browse files
ferdikoomenferdikoomen
committed
- Working on better HTML page
1 parent 33a3351 commit 8af2823

File tree

3 files changed

+190
-149
lines changed

3 files changed

+190
-149
lines changed

‎samples/README.html

Lines changed: 188 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,188 @@
1+
<!doctype html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta name="google" value="notranslate">
6+
<meta http-equiv="Content-Language" content="en_EN">
7+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8+
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/3.4.1/css/bootstrap.min.css" crossorigin="anonymous">
9+
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/3.4.1/css/bootstrap-theme.min.css" crossorigin="anonymous">
10+
<title>Compared to other libraries</title>
11+
</head>
12+
<body>
13+
<div class="container">
14+
<div class="page-header">
15+
<h1>Compared to other libraries</h1>
16+
<p class="lead">
17+
Depending on which generator you use, you will see different output. For instance:
18+
Different ways of generating models, services, level of quality, HTTP client, etc.
19+
I've compiled a list below with the results per area and how they compare
20+
against the openapi-typescript-codegen.
21+
</p>
22+
</div>
23+
<h5>I've used the standard petshop examples from OpenAPI:</h5>
24+
<ul>
25+
<li><a href="https://petstore3.swagger.io/api/v3/openapi.json" target="_blank">https://petstore3.swagger.io/api/v3/openapi.json</a></li>
26+
<li><a href="https://petstore.swagger.io/v2/swagger.json" target="_blank">https://petstore.swagger.io/v2/swagger.json</a></li>
27+
</ul>
28+
<hr/>
29+
<h5>And used the following generators with their default options:</h5>
30+
<ul>
31+
<li>typescript-aurelia</li>
32+
<li>typescript-angular</li>
33+
<li>typescript-inversify</li>
34+
<li>typescript-angular</li>
35+
<li>typescript-fetch</li>
36+
<li>typescript-jquery</li>
37+
<li>typescript-node</li>
38+
</ul>
39+
<hr/>
40+
<table class="table">
41+
<thead>
42+
<tr>
43+
<th width="30%"></th>
44+
<th width="10%">openapi-typscript-codegen</th>
45+
<th width="10%">aurelia</th>
46+
<th width="10%">inversify</th>
47+
<th width="10%">angular</th>
48+
<th width="10%">fetch</th>
49+
<th width="10%">jquery</th>
50+
<th width="10%">node</th>
51+
</tr>
52+
</thead>
53+
<tbody>
54+
<tr>
55+
<th>Supports OpenApi v2 specification</th>
56+
<td class="success">✅</td>
57+
<td class="success">✅</td>
58+
<td class="success">✅</td>
59+
<td class="success">✅</td>
60+
<td class="success">✅</td>
61+
<td class="success">✅</td>
62+
<td class="success">✅</td>
63+
</tr>
64+
<tr>
65+
<th>Supports OpenApi v3 specification</th>
66+
<td class="success">✅</td>
67+
<td class="danger">❌</td>
68+
<td class="danger">❌</td>
69+
<td class="success">✅</td>
70+
<td class="success">✅</td>
71+
<td class="danger">❌</td>
72+
<td class="danger">❌</td>
73+
</tr>
74+
<tr>
75+
<th>Supports authentication</th>
76+
<td class="success">✅</td>
77+
<td class="danger">❌</td>
78+
<td class="success">✅</td>
79+
<td class="success">✅</td>
80+
<td class="success">✅</td>
81+
<td class="success">✅</td>
82+
<td class="success">✅</td>
83+
</tr>
84+
<tr>
85+
<th>Strongly typed models</th>
86+
<td class="success">✅</td>
87+
<td class="success">✅</td>
88+
<td class="success">✅</td>
89+
<td class="success">✅</td>
90+
<td class="success">✅</td>
91+
<td class="success">✅</td>
92+
<td class="success">✅</td>
93+
</tr>
94+
<tr>
95+
<th>Strongly typed enums</th>
96+
<td class="success">✅</td>
97+
<td class="success">✅</td>
98+
<td class="success">✅</td>
99+
<td class="success">✅</td>
100+
<td class="success">✅</td>
101+
<td class="success">✅</td>
102+
<td class="success">✅</td>
103+
</tr>
104+
<tr>
105+
<th>Models and services exported as individual files</th>
106+
<td class="success">✅</td>
107+
<td class="danger">❌</td>
108+
<td class="success">✅</td>
109+
<td class="success">✅</td>
110+
<td class="danger">❌</td>
111+
<td class="success">✅</td>
112+
<td class="danger">❌</td>
113+
</tr>
114+
<tr>
115+
<th>Index file that exports all services and models</th>
116+
<td class="success">✅</td>
117+
<td class="success">✅</td>
118+
<td class="danger">❌</td>
119+
<td class="success">✅</td>
120+
<td class="success">✅</td>
121+
<td class="success">✅</td>
122+
<td class="danger">❌</td>
123+
</tr>
124+
<tr>
125+
<th>Service returns typed result</th>
126+
<td class="success">✅</td>
127+
<td class="success">✅</td>
128+
<td class="success">✅</td>
129+
<td class="success">✅</td>
130+
<td class="danger">❌</td>
131+
<td class="success">✅</td>
132+
<td class="success">✅</td>
133+
</tr>
134+
<tr>
135+
<th>Service supports sending and receiving binary content</th>
136+
<td class="success">✅</td>
137+
<td class="success">✅</td>
138+
<td class="success">✅</td>
139+
<td class="danger">❌</td>
140+
<td class="danger">❌</td>
141+
<td class="success">✅</td>
142+
<td class="success">✅</td>
143+
</tr>
144+
<tr>
145+
<th>Models and services contain inline documentation</th>
146+
<td class="success">✅</td>
147+
<td class="success">✅</td>
148+
<td class="success">✅</td>
149+
<td class="success">✅</td>
150+
<td class="success">✅</td>
151+
<td class="success">✅</td>
152+
<td class="success">✅</td>
153+
</tr>
154+
<tr>
155+
<th>Framework agnostic</th>
156+
<td class="success">✅</td>
157+
<td class="danger">❌</td>
158+
<td class="danger">❌</td>
159+
<td class="danger">❌</td>
160+
<td class="success">✅</td>
161+
<td class="danger">❌</td>
162+
<td class="danger">❌</td>
163+
</tr>
164+
<tr>
165+
<th>Generated size (typescript)</th>
166+
<td><span class="badge">30Kb</span></td>
167+
<td><span class="badge">30Kb</span></td>
168+
<td><span class="badge">30Kb</span></td>
169+
<td><span class="badge">30Kb</span></td>
170+
<td><span class="badge">30Kb</span></td>
171+
<td><span class="badge">30Kb</span></td>
172+
<td><span class="badge">30Kb</span></td>
173+
</tr>
174+
<tr>
175+
<th>Build size (javascript)</th>
176+
<td><span class="badge">30Kb</span></td>
177+
<td><span class="badge">30Kb</span></td>
178+
<td><span class="badge">30Kb</span></td>
179+
<td><span class="badge">30Kb</span></td>
180+
<td><span class="badge">30Kb</span></td>
181+
<td><span class="badge">30Kb</span></td>
182+
<td><span class="badge">30Kb</span></td>
183+
</tr>
184+
</tbody>
185+
</table>
186+
</div>
187+
</body>
188+
</html>

‎samples/README.md

Lines changed: 0 additions & 149 deletions
This file was deleted.

‎samples/codegen.sh

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,5 @@ java -jar ./swagger-codegen-cli-v3.jar generate -i v3/spec.json -l typescript-fe
1515

1616
node ../bin/index.js --input v2/spec.json --output examples/v2/openapi-typescript-codegen/
1717
node ../bin/index.js --input v3/spec.json --output examples/v3/openapi-typescript-codegen/
18+
19+
cd examples && find . -type f ! -iname "*.ts" -delete

0 commit comments

Comments
 (0)