Skip to content

Commit 69bca75

Browse files
BarakudumBarakudum
committed
completely reworked structure and added "What is DynAPI" page
1 parent ff1e7c2 commit 69bca75

File tree

14 files changed

+200
-53
lines changed

14 files changed

+200
-53
lines changed

‎src/webpage/.vitepress/nav.mts

Lines changed: 30 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,31 +2,51 @@ import { DefaultTheme } from "vitepress";
22

33
export default <DefaultTheme.NavItem[]>[
44
{
5-
text: "Quickstart",
6-
link: '/quickstart',
7-
activeMatch: '/quickstart',
5+
text: "Guide",
6+
link: '/guide/what-is-dynapi/',
7+
activeMatch: '/guide/',
88
},
99
{
10-
text: "Documentation",
11-
link: '/docs',
12-
activeMatch: '/docs',
10+
text: "References",
11+
link: '/references/',
12+
activeMatch: '/references/',
1313
},
1414
{
1515
text: "Repositories",
1616
items: [
17+
{
18+
text: "DynAPI",
19+
link: 'https://github.com/DynAPI/org.dynapi.DynAPI',
20+
target: '_blank',
21+
},
22+
{
23+
text: "DynAPI (v1)",
24+
link: 'https://github.com/DynAPI/DynAPI',
25+
target: '_blank',
26+
},
1727
{
1828
text: "DynAPI Website",
1929
link: 'https://github.com/DynAPI/DynAPI.github.io',
2030
target: '_blank',
2131
},
2232
{
23-
text: "DynAPI",
24-
link: 'https://github.com/DynAPI/org.dynapi.DynAPI',
33+
text: "The Interceptor",
34+
link: 'https://github.com/DynAPI/Interceptor',
2535
target: '_blank',
2636
},
2737
{
28-
text: "DynAPI (v1)",
29-
link: 'https://github.com/DynAPI/DynAPI',
38+
text: "org.dynapi:squirtle",
39+
link: 'https://github.com/DynAPI/org.dynapi.squirtle',
40+
target: '_blank',
41+
},
42+
{
43+
text: "org.dynapi:openapispec",
44+
link: 'https://github.com/DynAPI/org.dynapi.openapispec',
45+
target: '_blank',
46+
},
47+
{
48+
text: "org.dynapi:json-schema-gen",
49+
link: 'https://github.com/DynAPI/org.dynapi.jsonschemagen',
3050
target: '_blank',
3151
},
3252
]

‎src/webpage/.vitepress/sidebar.mts

Lines changed: 48 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,54 @@
11
import { DefaultTheme } from "vitepress";
22

3-
const sidebarDocumentation: DefaultTheme.SidebarItem[] = {
3+
const sidebarGuide: DefaultTheme.SidebarItem[] = [
4+
{
5+
text: "Introduction",
6+
items: [
7+
{
8+
text: "What is DynAPI?",
9+
link: "/guide/what-is-dynapi/",
10+
},
11+
{
12+
text: "Getting Started",
13+
link: "/guide/quickstart/",
14+
},
15+
{
16+
text: "Proxy Server",
17+
link: "/guide/proxy-server/",
18+
collapsed: true,
19+
items: [
20+
{
21+
text: "NGINX",
22+
link: "/guide/proxy-server/nginx/",
23+
},
24+
{
25+
text: "Apache",
26+
link: "/guide/proxy-server/apache/",
27+
}
28+
]
29+
},
30+
]
31+
},
32+
{
33+
text: "Configuration",
34+
link: "/references/config/"
35+
}
36+
]
437

5-
}
38+
const sidebarReferences: DefaultTheme.SidebarItem[] = [
39+
{
40+
text: "Reference",
41+
link: "/references/",
42+
items: [
43+
{
44+
text: "Configuration",
45+
link: "/references/config/"
46+
}
47+
]
48+
}
49+
]
650

751
export default <DefaultTheme.Sidebar>{
8-
'/docs/': {'base': '/docs/', items: sidebarDocumentation},
52+
'/guide/': { items: sidebarGuide },
53+
'/references/': { items: sidebarReferences },
954
}

‎src/webpage/src/data/databases.data.ts

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
export default {
2+
load(): Data[] {
3+
return <Data[]>[
4+
{ label: "ClickHouse", src: "/dbms-icons/clickhouse.svg" },
5+
{ label: "Microsoft SQL Server", src: "/dbms-icons/mssql.svg" },
6+
{ label: "MySQL", src: "/dbms-icons/mysql.svg" },
7+
{ label: "Oracle", src: "/dbms-icons/oracle.png" },
8+
{ label: "PostgreSQL", src: "/dbms-icons/postgresql.svg" },
9+
{ label: "Redshift", src: "/dbms-icons/redshift.svg" },
10+
{ label: "Snowflake", src: "/dbms-icons/snowflake.svg" },
11+
{ label: "SQLite", src: "/dbms-icons/sqlite.svg" },
12+
]
13+
}
14+
}

‎src/webpage/src/data/members.data.ts

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
export default {
2+
load() {
3+
return [
4+
{
5+
avatar: 'https://www.github.com/PlayerG9.png',
6+
name: 'PlayerG9',
7+
title: 'Creator',
8+
links: [
9+
{ icon: 'github', link: 'https://github.com/PlayerG9' },
10+
]
11+
},
12+
]
13+
}
14+
}

‎src/webpage/src/docs/index.md

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

‎src/webpage/src/guide/proxy-server/apache/index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Proxy-Server: Apache
2+
3+
> [!INFO]
4+
> As of now, DynAPI v2 is under development and a stable release is not available.
5+
> For this reason there are currently no Apache tutorial available.
6+
>
7+
> Please be patient and revisit our webpage to look for updates.

‎src/webpage/src/guide/proxy-server/index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Proxy-Server
2+
3+
> [!INFO]
4+
> As of now, DynAPI v2 is under development and a stable release is not available.
5+
> For this reason there are currently no proxy-server tutorials available.
6+
>
7+
> Please be patient and revisit our webpage to look for updates.

‎src/webpage/src/guide/proxy-server/nginx/index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Proxy-Server: NGINX
2+
3+
> [!INFO]
4+
> As of now, DynAPI v2 is under development and a stable release is not available.
5+
> For this reason there are currently no NGINX tutorial available.
6+
>
7+
> Please be patient and revisit our webpage to look for updates.

‎src/webpage/src/guide/quickstart/index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Quickstart
2+
3+
> [!INFO]
4+
> As of now, DynAPI v2 is under development and a stable release is not available.
5+
> For this reason there is currently no quickstart tutorial available.
6+
>
7+
> Please be patient and revisit our webpage to look for updates.

‎src/webpage/src/guide/what-is-dynapi/index.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
<script setup>
2+
import { data as databases } from "/data/databases.data.ts";
3+
</script>
4+
5+
# What is DynAPI?
6+
7+
DynAPI is a **Dyn**amic **API** for many databases. \
8+
It has
9+
- an easy setup
10+
- fast response times
11+
- good automatic documentation (with [Redoc](https://redocly.com/redoc) and [Swagger](https://swagger.io/tools/swagger-ui/)).
12+
13+
<div class="tip custom-block" style="padding-top: 8px">
14+
15+
Just want to try it out? Skip to the [Quickstart](../quickstart/index.md).
16+
17+
</div>
18+
19+
## Use Cases
20+
21+
- **Development**
22+
23+
DynAPI can be used to provide a fully documented Rest-API for your Database.
24+
This way your frontend can start working while the backend is still under (early) development.
25+
26+
- **Production**
27+
28+
While DynAPI can be used as a development backend. It is fully capable to run in production and handle thousands of requests simultaneously.
29+
30+
## What About DynAPI?
31+
32+
DynAPI is the successor of [DynAPI (v1)](https://github.com/DynAPI/DynAPI).
33+
The original DynAPI was written in Python with Flask and was made for PostgreSQL databases.
34+
Rewritten in Java with Spring-Boot, the new DynAPI provides a significant boost in performance.
35+
36+
While DynAPI (v1) could only work with PostgreSQL databases, the new DynAPI supports more DBMS.
37+
(see [supported database](#supported-databases))
38+
39+
## Supported Databases
40+
41+
<ul>
42+
<li v-for="database in databases">
43+
<img style="display: inline-block; height: 1em; margin-right: 0.5em;" :src="database.src" :alt="database.label" />
44+
<span>{{ database.label }}</span>
45+
</li>
46+
</ul>

0 commit comments

Comments
 (0)