add integration description

chriskapp · chriskapp · commit feeab8417748 · 2024-11-22T22:28:57.000+01:00
diff --git a/www/resources/template/ecosystem.php b/www/resources/template/ecosystem.php
@@ -9,10 +9,11 @@
 
 <div class="container">
   <h1 class="display-4">Ecosystem</h1>
-  <p class="lead">The following page lists integrations, libraries and other projects related to TypeSchema.</p>
+  <p class="lead">The following page lists libraries, integrations and other projects related to TypeSchema.</p>
 
   <h2>Model</h2>
-  <p>We provide auto-generated models of the TypeSchema specification which can be used to parse or generate a TypeSchema specification.</p>
+  <p>We provide auto-generated models of the TypeSchema meta specification which describes itself.
+    These models can be used to parse or generate a TypeSchema specification.</p>
   <table class="table table-striped">
     <colgroup>
       <col class="w-25">
@@ -60,8 +61,16 @@
     </tbody>
   </table>
 
+  <!--
+  <h2>Reflection</h2>
+  <p>The reflection libraries help to automatically generate a TypeSchema specification based on a class.
+    These libraries use the reflection mechanism of each language to inspect the class and create the fitting
+    schema.</p>
+  -->
+
   <h2>Integration</h2>
-  <p></p>
+  <p>If you want to integrate the code generator you can take a look at the following options. For more advanced
+    integration options you can also take a look at the <a href="https://sdkgen.app/">SDKgen</a> project.</p>
   <table class="table table-striped">
     <colgroup>
       <col class="w-25">
@@ -89,27 +98,6 @@
     </tbody>
   </table>
 
-  <h2>Library</h2>
-  <p></p>
-  <table class="table table-striped">
-    <colgroup>
-      <col class="w-25">
-      <col class="w-50">
-    </colgroup>
-    <thead>
-    <tr>
-      <th>Name</th>
-      <th>Description</th>
-    </tr>
-    </thead>
-    <tbody>
-    <tr>
-      <td><a href="https://github.com/apioo/psx-schema">psx-schema</a></td>
-      <td>A PHP library to parse and validate TypeSchema specifications</td>
-    </tr>
-    </tbody>
-  </table>
-
   <h2>Frontend</h2>
   <p></p>
   <table class="table table-striped">
diff --git a/www/resources/template/integration/csharp_description.html b/www/resources/template/integration/csharp_description.html
@@ -0,0 +1,2 @@
+The C# TypeSchema integration uses the native <a href="https://learn.microsoft.com/en-us/dotnet/standard/serialization/system-text-json/overview">System.Text.Json</a>
+implementation, this means you don`t need to install any additional package to use the generated DTOs.
diff --git a/www/resources/template/integration/detail.php b/www/resources/template/integration/detail.php
@@ -9,6 +9,7 @@
 
 <div class="container">
   <h1 class="display-4"><?php echo $typeName; ?> Integration</h1>
+  <div class="mt-3 mb-3"><?php echo $description; ?></div>
   <div class="row">
     <div class="col-6">
       <div class="psx-object">
diff --git a/www/resources/template/integration/go_description.html b/www/resources/template/integration/go_description.html
@@ -0,0 +1 @@
+The Go TypeSchema integration uses the native JSON implementation, this means you don`t need to install any additional package to use the generated DTOs.
diff --git a/www/resources/template/integration/java_description.html b/www/resources/template/integration/java_description.html
@@ -0,0 +1,21 @@
+The Java TypeSchema integration uses the well known <a href="https://central.sonatype.com/namespace/com.fasterxml.jackson.core">Jackson ObjectMapper</a> library.
+To use the generated DTO classes you need to add this library to your project:
+
+<pre><code class="xml">&lt;dependencies&gt;
+    &lt;dependency&gt;
+        &lt;groupId&gt;com.fasterxml.jackson.core&lt;/groupId&gt;
+        &lt;artifactId&gt;jackson-core&lt;/artifactId&gt;
+        &lt;version&gt;2.13.4&lt;/version&gt;
+    &lt;/dependency&gt;
+    &lt;dependency&gt;
+        &lt;groupId&gt;com.fasterxml.jackson.core&lt;/groupId&gt;
+        &lt;artifactId&gt;jackson-databind&lt;/artifactId&gt;
+        &lt;version&gt;2.13.4&lt;/version&gt;
+    &lt;/dependency&gt;
+    &lt;dependency&gt;
+        &lt;groupId&gt;com.fasterxml.jackson.datatype&lt;/groupId&gt;
+        &lt;artifactId&gt;jackson-datatype-jsr310&lt;/artifactId&gt;
+        &lt;version&gt;2.13.4&lt;/version&gt;
+    &lt;/dependency&gt;
+&lt;/dependencies&gt;
+</code></pre>
diff --git a/www/resources/template/integration/php_description.html b/www/resources/template/integration/php_description.html
@@ -0,0 +1,9 @@
+The PHP TypeSchema integration uses the <a href="https://packagist.org/packages/psx/schema">psx/schema</a> library. To use the generated DTO classes you need
+to add the following composer dependency:
+
+<pre><code class="json">{
+  "require": {
+    "psx/schema": "^7.0"
+  }
+}
+</code></pre>
diff --git a/www/resources/template/integration/python_description.html b/www/resources/template/integration/python_description.html
@@ -0,0 +1,4 @@
+The Python TypeSchema integration uses the well known <a href="https://pypi.org/project/pydantic/">Pydantic</a> library.
+To use the generated DTO classes you need to add this library to your project:
+
+<pre><code class="text">pydantic~=2.9.2</code></pre>
diff --git a/www/resources/template/integration/python_dto.txt b/www/resources/template/integration/python_dto.txt
@@ -0,0 +1,12 @@
+from pydantic import BaseModel, Field, GetCoreSchemaHandler
+from pydantic_core import CoreSchema, core_schema
+from typing import Any, Dict, Generic, List, Optional, TypeVar
+
+
+# A simple student struct
+class Student(BaseModel):
+    first_name: Optional[str] = Field(default=None, alias="firstName")
+    last_name: Optional[str] = Field(default=None, alias="lastName")
+    age: Optional[int] = Field(default=None, alias="age")
+    pass
+
diff --git a/www/resources/template/integration/python_integration.txt b/www/resources/template/integration/python_integration.txt
@@ -0,0 +1,8 @@
+input = Path('input.json').read_text()
+
+student = Student.model_validate_json(input)
+
+output = student.model_dump_json()
+
+Path('output.json').write_text(output)
+
diff --git a/www/resources/template/integration/rust_description.html b/www/resources/template/integration/rust_description.html
@@ -0,0 +1,8 @@
+The Rust TypeSchema integration uses the well known <a href="https://serde.rs/">Serde</a> library.
+To use the generated DTO classes you need to add this library to your project:
+
+<pre><code class="text">[dependencies]
+serde = { version = "1.0", features = ["derive"] }
+serde_json = "1.0"
+chrono = { version = "0.4", features = ["serde"] }
+</code></pre>
diff --git a/www/resources/template/integration/rust_dto.txt b/www/resources/template/integration/rust_dto.txt
@@ -0,0 +1,15 @@
+use serde::{Serialize, Deserialize};
+
+// A simple student struct
+#[derive(Serialize, Deserialize)]
+pub struct Student {
+    #[serde(rename = "firstName")]
+    first_name: Option<String>,
+
+    #[serde(rename = "lastName")]
+    last_name: Option<String>,
+
+    #[serde(rename = "age")]
+    age: Option<u64>,
+
+}
diff --git a/www/resources/template/integration/rust_integration.txt b/www/resources/template/integration/rust_integration.txt
@@ -0,0 +1,18 @@
+extern crate serde;
+extern crate serde_json;
+extern crate chrono;
+
+use std::fs;
+use student::Student;
+
+mod student;
+
+fn main() {
+    let input = fs::read_to_string("input.json").expect("Could not read input");
+
+    let student: Student = serde_json::from_str(&input).unwrap();
+
+    let output = serde_json::to_string(&student).unwrap();
+
+    fs::write("output.json", output).expect("Could not write output");
+}
diff --git a/www/resources/template/integration/visualbasic_description.html b/www/resources/template/integration/visualbasic_description.html
@@ -0,0 +1,2 @@
+The VisualBasic TypeSchema integration uses the native <a href="https://learn.microsoft.com/en-us/dotnet/standard/serialization/system-text-json/overview">System.Text.Json</a>
+implementation, this means you don`t need to install any additional package to use the generated DTOs.
diff --git a/www/resources/template/integration/visualbasic_dto.txt b/www/resources/template/integration/visualbasic_dto.txt
@@ -0,0 +1,14 @@
+Imports System.Text.Json.Serialization
+
+' A simple student struct
+Public Class Student
+    <JsonPropertyName("firstName")>
+    Public Property FirstName As String
+
+    <JsonPropertyName("lastName")>
+    Public Property LastName As String
+
+    <JsonPropertyName("age")>
+    Public Property Age As Integer
+
+End Class
diff --git a/www/resources/template/integration/visualbasic_integration.txt b/www/resources/template/integration/visualbasic_integration.txt
@@ -0,0 +1,19 @@
+Imports System.Text.Json
+Imports Generator.Generator
+Imports Microsoft.VisualBasic.FileIO
+
+Module Program
+    Sub Main(args as String())
+        Dim input As String
+        Dim output As String
+        Dim student As Student
+
+        input = FileSystem.ReadAllText("input.json")
+
+        student = JsonSerializer.Deserialize(Of Student)(input)
+
+        output = JsonSerializer.Serialize(student)
+
+        FileSystem.WriteAllText("output.json", output, True)
+    End Sub
+End Module

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+The C# TypeSchema integration uses the native <a href="https://learn.microsoft.com/en-us/dotnet/standard/serialization/system-text-json/overview">System.Text.Json</a>`
	`2`	+implementation, this means you don`t need to install any additional package to use the generated DTOs.
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+The Go TypeSchema integration uses the native JSON implementation, this means you don`t need to install any additional package to use the generated DTOs.