A very random collection of services, packed into a RESTful Rust api. https://fej.roosens.me
 
 
 
 
 
 
Go to file
Jef Roosens d466ab6d13
Merge branch 'master' into develop
2021-04-13 22:12:17 +02:00
.hooks [closes #6] added documentation everywhere 2021-04-12 21:33:56 +02:00
benches [#13] Further overhaul of the project structure for better testing 2021-04-08 22:39:04 +02:00
docker [#19] Fixed api not working from outside container 2021-04-13 21:56:52 +02:00
src [#19] Small changes 2021-04-12 23:03:15 +02:00
tests [#13] added some more unit tests, hated life for a bit 2021-04-08 22:53:29 +02:00
.dockerignore Added Docker build files 2021-03-05 20:40:49 +01:00
.gitignore Added cargo init 2021-03-05 18:39:49 +01:00
Cargo.lock Bumped version to 1.0.0 2021-04-13 22:05:31 +02:00
Cargo.toml Bumped version to 1.0.0 2021-04-13 22:05:31 +02:00
LICENSE [closes #20] Switched to AGPLv3 2021-04-13 22:03:27 +02:00
Makefile Tiny fix in Makefile 2021-04-13 22:09:50 +02:00
README.md Merge branch 'develop' 2021-04-12 15:53:07 +02:00
build [#17] Small changes to build script 2021-04-12 18:19:22 +02:00
roadmap.md Started roadmap.md 2021-03-23 13:47:57 +01:00

README.md

Fej

Fej is an API written in Rust. I started this project to learn the language, and really just have some fun.

Project Structure

The folder structure follows the structure of the URLs, e.g. the route for /hello/world is found in the module src/hello.

Each module contains the following base files:

  • mod.rs: defines the modules' content, and contains the route definitions. The route functions themselves only contain the functionality needed to represent the data, not acquire it.
  • controller.rs: this file contains the actual logic of each route. If the logic becomes too complicated to be contained inside a single file, controller.rs becomes its own module folder named controller.
  • tests.rs: this contains tests for the specific module. This can also be a module directory if need be.

Every module has a routes function that returns its route macros.

Roadmap

See roadmap.md.