Skip to content

Commit

Permalink
update headings and ecosystem
Browse files Browse the repository at this point in the history
  • Loading branch information
chriskapp committed Nov 25, 2023
1 parent 0b42a45 commit 6650a72
Show file tree
Hide file tree
Showing 6 changed files with 26 additions and 9 deletions.
2 changes: 1 addition & 1 deletion www/public/css/app.css
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ textarea {
border:1px solid #ccc;
}

.psx-object > h1 {
.psx-object > h3 {
font-weight:bold;
font-size:1em;
margin:0;
Expand Down
2 changes: 1 addition & 1 deletion www/public/css/app.min.css

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion www/resources/template/developer.php
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<hr>

<a id="Generator"></a>
<h3>Generator</h3>
<h2>Generator</h2>

<p>The following script is a very naive generator implementation which should show how to read a TypeAPI specification
and produce a different output. In this case we simply generate a documentation format but it should give a good
Expand Down
19 changes: 18 additions & 1 deletion www/resources/template/ecosystem.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,12 @@

<h1 class="display-4">Ecosystem</h1>

<p class="lead">The following page shows different services working with the TypeAPI specification.</p>
<p class="lead">The following page shows different services and tools working with the TypeAPI specification.</p>

<hr>

<h2>Services</h2>

<a id="SDKgen"></a>
<h3><a href="https://sdkgen.app/">SDKgen</a></h3>
<p>SDKgen is a service which provides a code generator as REST API, you can consume the API either manually or through
Expand All @@ -33,6 +35,21 @@

<hr>

<h2>Tools</h2>

<a id="TypeAPI-Editor"></a>
<h3><a href="https://github.com/apioo/typeschema-angular-editor">TypeAPI-Editor</a></h3>
<p>Angular component which allows you to build and view TypeAPI specifications. We provide a current version at
our <a href="https://sandbox.typeapi.org/">Sandbox</a> page.</p>

<a id="SDKgen-Generator-Action"></a>
<h3><a href="https://github.com/apioo/sdkgen-generator-action">SDKgen-Generator-Action</a></h3>
<p>GitHub action which allows you to generate code through a GitHub workflow action.</p>

<a id="SDKgen-Generator-CLI"></a>
<h3><a href="https://github.com/apioo/sdkgen-cli">SDKgen-Generator-CLI</a></h3>
<p>A simple binary written in go which allows you to generate code.</p>

<div class="typeschema-edit">
<a href="https://github.com/apioo/typeapi/blob/main/www/resources/template/<?php echo pathinfo(__FILE__, PATHINFO_BASENAME); ?>"><i class="bi bi-pencil"></i> Edit this page</a>
</div>
Expand Down
4 changes: 2 additions & 2 deletions www/resources/template/index.php
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,13 @@
</div>
<div class="col-md-6">
<div class="psx-object">
<h1>TypeAPI</h1>
<h3>TypeAPI</h3>
<div class="example-box"><pre><code class="json"><?php echo $example->schema; ?></code></pre></div>
</div>
</div>
<div class="col-md-6">
<div class="psx-object">
<h1>Client SDK</h1>
<h3>Client SDK</h3>
<div class="example-box"><pre><code class="javascript"><?php echo htmlspecialchars($example->code); ?></code></pre></div>
</div>
</div>
Expand Down
6 changes: 3 additions & 3 deletions www/resources/template/specification.php
Original file line number Diff line number Diff line change
Expand Up @@ -37,23 +37,23 @@
<hr>

<a id="Goals"></a>
<h3>Goals</h3>
<h2>Goals</h2>
<ul>
<li>Provide a format to generate clean and ready to use code</li>
<li>Provide a simple and stable specification where you can easily build a code generator</li>
<li>Optimized for static typed and object-oriented programming languages</li>
</ul>

<a id="Non-Goals"></a>
<h3>Non-Goals</h3>
<h2>Non-Goals</h2>
<ul>
<li>Describe every possible REST API structure and JSON payload</li>
<li>Supporting many different Content-Types like XML or <code>x-www-form-urlencoded</code></li>
<li>Providing complex JSON validation capabilities</li>
</ul>

<a id="Reasoning"></a>
<h3>Reasoning</h3>
<h2>Reasoning</h2>
<p>For a long time the OpenAPI community was divided into two communities, one building documentation tools and the
other trying to build code generation tools. Building documentation tools has very different requirements than
building code generation tools. For a documentation tool you can simply render and show all defined endpoints and
Expand Down

0 comments on commit 6650a72

Please sign in to comment.