zawz/actix-surreal
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc: add readme

Browse source
This commit is contained in:
zawz 2024-07-24 13:29:54 +02:00
parent 493517487a
commit d17cfbf913
2 changed files with 10 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
.gitignore vendored
View file

@ -1,4 +1,5 @@
/target /target
framework/target
.env .env
token.json token.json
token.txt token.txt

9
README.md Normal file
View file

@ -0,0 +1,9 @@
Web API experiment with actix and surrealDB.
Generate doc: `cargo doc --workspace --no-deps --open`
- Oauth2/OpenID JWT token for authentication provided by keycloak, with internal permissions in application
- Easy-to-use cache wrapper, only implements Moka but can be easily extended. [More](framework/src/cache)
- Derive filter structs for surrealDB queries. [More](framework/macros/)
- CRUD API with filtering, and dynamic ID (user can be referenced by either id, oidc_id, or username)