mirror of
https://github.com/SoftEtherVPN/SoftEtherVPN.git
synced 2025-07-07 00:04:57 +03:00
Update developer tools for JSON-RPC
This commit is contained in:
Daiyuu Nobori
@ -1521,6 +1521,8 @@ namespace VPNServer_JSONRPC_CodeGen
|
||||
w.WriteLine($"<a id=\"{rpc.Name.ToLowerInvariant()}\"></a>");
|
||||
w.WriteLine($"## \"{rpc.Name}\" RPC API - {func_summary}");
|
||||
|
||||
w.WriteLine("### Description");
|
||||
|
||||
w.WriteLine(rpc.Symbol.GetDocumentStr());
|
||||
|
||||
var model = cs_tests.Model;
|
||||
@ -1809,13 +1811,16 @@ namespace VPNServer_JSONRPC_CodeGen
|
||||
|
||||
foreach (RpcInfo rpc in rpc_list.Values)
|
||||
{
|
||||
doc_write_function(w, rpc);
|
||||
if (rpc.Name.IndexOf("Vgs", StringComparison.Ordinal) == -1)
|
||||
{
|
||||
doc_write_function(w, rpc);
|
||||
|
||||
w.WriteLine("***");
|
||||
w.WriteLine("***");
|
||||
}
|
||||
}
|
||||
|
||||
w.WriteLine($"Automatically generated at {timestamp.ToString("yyyy-MM-dd HH:mm:ss")} by vpnserver-jsonrpc-codegen. ");
|
||||
w.WriteLine("Copyright (c) 2014 - " + DateTime.Now.Year + " [SoftEther VPN Project](https://www.softether.org/) under the Apache License 2.0. ");
|
||||
w.WriteLine("Copyright (c) 2014-" + DateTime.Now.Year + " [SoftEther VPN Project](https://www.softether.org/) under the Apache License 2.0. ");
|
||||
w.WriteLine();
|
||||
|
||||
ret.DocsRpc = w.ToString();
|
||||
@ -1967,6 +1972,9 @@ namespace VPNServer_JSONRPC_CodeGen
|
||||
|
||||
save(Path.Combine(output_dir, "vpnrpc.ts"), ts_rpc, true);
|
||||
save(Path.Combine(output_dir, "sample.ts"), ts_test, true);
|
||||
|
||||
save(Path.Combine(output_dir + "/../vpnserver-jsonrpc-client-nodejs-package/src/", "vpnrpc.ts"), ts_rpc, true);
|
||||
save(Path.Combine(output_dir + "/../vpnserver-jsonrpc-client-nodejs-package/src/", "sample.ts"), ts_test, true);
|
||||
}
|
||||
|
||||
void output_csharp(string output_dir)
|
||||
|
||||
@ -1,8 +1,18 @@
|
||||
# SoftEther VPN Server JSON-RPC Document
|
||||
# SoftEther VPN Server JSON-RPC API Suite Document
|
||||
This reference describes all JSON-RPC functions available on SoftEther VPN Server.
|
||||
|
||||
|
||||
Please note that you can use [SoftEther VPN Server JSON-RPC Client Library](https://github.com/SoftEtherVPN/SoftEtherVPN/tree/master/developer_tools/vpnserver-jsonrpc-clients/) to call these APIs easily instead of calling JSON through HTTPS.
|
||||
You can access to the latest [SoftEther VPN Server JSON-RPC Document on GitHub](https://github.com/SoftEtherVPN/SoftEtherVPN/tree/master/developer_tools/vpnserver-jsonrpc-clients/).
|
||||
|
||||
|
||||
## What is SoftEther VPN Server JSON-RPC API Suite?
|
||||
The API Suite allows you to easily develop your original SoftEther VPN Server management application to control the VPN Server (e.g. creating users, adding Virtual Hubs, disconnecting a specified VPN sessions).
|
||||
|
||||
- Almost all control APIs, which the VPN Server provides, are available as JSON-RPC API.
|
||||
- You can write your own VPN Server management application in your favorite languages (JavaScript, TypeScript, Java, Python, Ruby, C#, ... etc.)
|
||||
- If you are planning to develop your own VPN cloud service, the JSON-RPC API is the best choice to realize the automated operations for the VPN Server.
|
||||
- No need to use any specific API client library since all APIs are provided on the [JSON-RPC 2.0 Specification](https://www.jsonrpc.org/specification). You can use your favorite JSON and HTTPS client library to call any of all APIs in your pure runtime environment.
|
||||
- Also, the SoftEther VPN Project provides high-quality JSON-RPC client stub libraries which define all of the API client stub codes. These libraries are written in C#, JavaScript and TypeScript. [The Node.js Client Library for VPN Server RPC (vpnrpc)](https://www.npmjs.com/package/vpnrpc) package is also available.
|
||||
|
||||
|
||||
## Principle
|
||||
@ -13,13 +23,46 @@ The entry point URL of JSON-RPC is:
|
||||
https://<vpn_server_hostname>:<port>/api/
|
||||
```
|
||||
|
||||
- Older versions of SoftEther VPN before June 2019 don't support JSON-RPC APIs.
|
||||
- If you want to completely disable the JSON-RPC on your VPN Server, set the `DisableJsonRpcWebApi` variable to `true` on the `vpn_server.config`.
|
||||
|
||||
|
||||
### JSON-RPC specification
|
||||
You must use HTTPS 1.1 `POST` method to call each of JSON-RPC APIs.
|
||||
All APIs are based on the [JSON-RPC 2.0 Specification](https://www.jsonrpc.org/specification).
|
||||
- JSON-RPC Notification is not supported.
|
||||
- JSON-RPC Batch is not supported.
|
||||
|
||||
### Authentication
|
||||
|
||||
### "vpnrpc": Node.js Client Library package for VPN Server JSON-RPC
|
||||
If you are willing to develop your original JSON-RPC client for SoftEther VPN, you can use the [JavaScript Client Library for VPN Server RPC (vpnrpc)](https://www.npmjs.com/package/vpnrpc).
|
||||
|
||||
- You can use the `vpnrpc` library in JavaScript for both web browsers (e.g. Chrome, FireFox or Edge) and Node.js.
|
||||
- As a sample code there is the [sample.ts](https://github.com/SoftEtherVPN/SoftEtherVPN/tree/master/developer_tools/vpnserver-jsonrpc-clients/vpnserver-jsonrpc-client-typescript/sample.ts) program in TypeScript. This sample calls all of available JSON-RPC APIs against the specified SoftEther VPN Server. (Note: This sample code is written in TypeScript.)
|
||||
|
||||
You can use the following command to download the `vpnrpc` library package with Node.js.
|
||||
```
|
||||
$ npm install --save-dev vpnrpc
|
||||
```
|
||||
|
||||
|
||||
|
||||
### "vpnrpc.ts": TypeScript Client Library for VPN Server JSON-RPC
|
||||
If you are willing to develop your original JSON-RPC client for SoftEther VPN, you can use the [TypeScript Client Library for VPN Server RPC (vpnrpc.ts)](https://github.com/SoftEtherVPN/SoftEtherVPN/tree/master/developer_tools/vpnserver-jsonrpc-clients/vpnserver-jsonrpc-client-typescript/).
|
||||
|
||||
- You can use the [vpnrpc.ts](https://github.com/SoftEtherVPN/SoftEtherVPN/tree/master/developer_tools/vpnserver-jsonrpc-clients/vpnserver-jsonrpc-client-typescript/vpnrpc.ts) library in TypeScript / JavaScript for both web browsers (e.g. Chrome, FireFox or Edge) and Node.js.
|
||||
- As a sample code there is the [sample.ts](https://github.com/SoftEtherVPN/SoftEtherVPN/tree/master/developer_tools/vpnserver-jsonrpc-clients/vpnserver-jsonrpc-client-typescript/sample.ts) program in TypeScript. This sample calls one by one all of available JSON-RPC APIs against the specified SoftEther VPN Server.
|
||||
|
||||
|
||||
### "vpnserver-jsonrpc-client-csharp": C# Client Library for VPN Server JSON-RPC
|
||||
If you are willing to develop your original JSON-RPC client for SoftEther VPN, you can use the [vpnserver-jsonrpc-client-csharp C# library](https://github.com/SoftEtherVPN/SoftEtherVPN/tree/master/developer_tools/vpnserver-jsonrpc-client-csharp/).
|
||||
|
||||
- The [client library codes for C#](https://github.com/SoftEtherVPN/SoftEtherVPN/tree/master/developer_tools/vpnserver-jsonrpc-client-csharp/rpc-stubs/) is written in pure C# 7.3. It works on .NET Core 2.1 or later on Windows, Linux and macOS. Very comfort with Visual Studio for both Windows or macOS.
|
||||
- As a sample code there is the [VpnServerRpcTest.cs](https://github.com/SoftEtherVPN/SoftEtherVPN/tree/master/developer_tools/vpnserver-jsonrpc-client-csharp/sample/VpnServerRpcTest.cs) program in C#. This sample calls one by one all of available JSON-RPC APIs against the specified SoftEther VPN Server.
|
||||
|
||||
|
||||
|
||||
### HTTPS Authentication
|
||||
You must specify the following HTTPS custom headers for authentication on each of requests.
|
||||
|
||||
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<title>SoftEther VPN Server JSON-RPC Document</title>
|
||||
<title>SoftEther VPN Server JSON-RPC Suite Document</title>
|
||||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/github-markdown-css/2.10.0/github-markdown.css">
|
||||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/prism/1.15.0/themes/prism.css">
|
||||
</head>
|
||||
|
||||
Reference in New Issue
Block a user