From d4939e8694a6762dc9de2f4027266850f49790ac Mon Sep 17 00:00:00 2001 From: jwijenbergh Date: Mon, 1 May 2023 14:19:32 +0200 Subject: Docs: Update API section for V2 --- docs/src/api/architecture.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 docs/src/api/architecture.md (limited to 'docs/src/api/architecture.md') diff --git a/docs/src/api/architecture.md b/docs/src/api/architecture.md new file mode 100644 index 0000000..72f63ef --- /dev/null +++ b/docs/src/api/architecture.md @@ -0,0 +1,11 @@ +# Architecture +In the previous section, we have already hinted a bit on the exact architecture. This section will expand upon it by giving a figure of the basic structure + +```mermaid +graph TD; +A[Go]-- Compiles to -->B[C shared library .so/.dll]; +C[Language wrapper]-- Loads -->B +Client -- Uses --> C; +``` + +As can be seen by this architecture, there is an intermediate layer between the client and the *shared* library. This wrapper eases the way of loading this library and then defining a more language specific API for it. In the eduvpn-common repo, we currently only support a Python wrapper. Clients themselves can define their own wrapper -- cgit v1.2.3