proxmox-mirrors/proxmox
1
0
Fork 1
mirror of https://git.proxmox.com/git/proxmox synced 2025-05-29 21:14:18 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

rest-server: update example to new ApiConfig

Browse Source 
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
This commit is contained in:
Wolfgang Bumiller 2023-03-02 15:53:30 +01:00
parent 1f373b9276
commit dcd6e85ab2
1 changed files with 32 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

74
proxmox-rest-server/examples/minimal-rest-server.rs
View File

@ -14,7 +14,7 @@ use proxmox_router::{
}; };
use proxmox_schema::api; use proxmox_schema::api;
use proxmox_rest_server::{ApiConfig, AuthError, RestEnvironment, RestServer, ServerAdapter}; use proxmox_rest_server::{ApiConfig, AuthError, RestEnvironment, RestServer};
// Create a Dummy User information system // Create a Dummy User information system
struct DummyUserInfo; struct DummyUserInfo;
@ -32,42 +32,34 @@ impl UserInformation for DummyUserInfo {
} }
} }
struct MinimalServer; fn check_auth<'a>(
_headers: &'a HeaderMap,
_method: &'a Method,
) -> Pin<
Box<
dyn Future<Output = Result<(String, Box<dyn UserInformation + Sync + Send>), AuthError>>
+ Send
+ 'a,
>,
> {
Box::pin(async move {
// get some global/cached userinfo
let userinfo: Box<dyn UserInformation + Sync + Send> = Box::new(DummyUserInfo);
// Do some user checks, e.g. cookie/csrf
Ok(("User".to_string(), userinfo))
})
}
// implement the server adapter fn get_index(
impl ServerAdapter for MinimalServer { _env: RestEnvironment,
// normally this would check and authenticate the user _parts: Parts,
fn check_auth( ) -> Pin<Box<dyn Future<Output = Response<Body>> + Send>> {
&self, Box::pin(async move {
_headers: &HeaderMap, // build an index page
_method: &Method, http::Response::builder()
) -> Pin< .body("hello world".into())
Box< .unwrap()
dyn Future<Output = Result<(String, Box<dyn UserInformation + Sync + Send>), AuthError>> })
+ Send,
>,
> {
Box::pin(async move {
// get some global/cached userinfo
let userinfo: Box<dyn UserInformation + Sync + Send> = Box::new(DummyUserInfo);
// Do some user checks, e.g. cookie/csrf
Ok(("User".to_string(), userinfo))
})
}
// this should return the index page of the webserver, iow. what the user browses to
fn get_index(
&self,
_env: RestEnvironment,
_parts: Parts,
) -> Pin<Box<dyn Future<Output = Response<Body>> + Send>> {
Box::pin(async move {
// build an index page
http::Response::builder()
.body("hello world".into())
.unwrap()
})
}
} }
// a few examples on how to do api calls with the Router // a few examples on how to do api calls with the Router
@ -199,12 +191,10 @@ const ROUTER: Router = Router::new()
async fn run() -> Result<(), Error> { async fn run() -> Result<(), Error> {
// we first have to configure the api environment (basedir etc.) // we first have to configure the api environment (basedir etc.)
let config = ApiConfig::new( let config = ApiConfig::new("/var/tmp/", RpcEnvironmentType::PUBLIC)
"/var/tmp/", .default_api2_handler(&ROUTER)
&ROUTER, .auth_handler_func(check_auth)
RpcEnvironmentType::PUBLIC, .index_handler_func(get_index);
MinimalServer,
)?;
let rest_server = RestServer::new(config); let rest_server = RestServer::new(config);
// then we have to create a daemon that listens, accepts and serves the api to clients // then we have to create a daemon that listens, accepts and serves the api to clients