API Notes and Documentation

[stravid87]

Description
Notes and ideas and scribbles about creating / building out the necessary documentation for @marclupanc & future developers wanting to build on layer8.

Acceptance Criteria

• Public API documentation @ docs.layer8proxy.net

Notes

1. NPM Pkg / repo
2. Github repo
3. Readme
4. Coordinated SemVer on all public repos

*Service Provider Responsibilities

1. In the SPA, configuring the Interceptor correctly

import { initEncryptedTunnel, ServiceProvider } from "interceptor-wasm"

let forward_proxy_url = import.meta.env.VITE_FORWARD_PROXY_URL || 'http://localhost:6191';
let backend_url = import.meta.env.VITE_BACKEND_URL || 'http://10.10.10.102:6193';

try {
    let providers = [ServiceProvider.new(backend_url)];
    initEncryptedTunnel(forward_proxy_url, providers);
} catch (err) {
    throw new Error(`Failed to initialize encrypted tunnel: ${err}`);
}

2. Certs?

3. Local host:5001?