From 5bd9e2f688de0b572b05d728539dd678e3bd4a4e Mon Sep 17 00:00:00 2001 From: xdrm-brackets Date: Wed, 30 May 2018 17:01:16 +0200 Subject: [PATCH] add readme --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..3c7ef42 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# xfw: all-in-one REST API + + + +**xfw** is a self-working API coded in *Go*: + +- It allows anyone to create a fully featured REST API +- it can be used in *Go* as a library, or as a proxy to launch external commands (*e.g. php scripts*) + +It is based on the *all-in-config* idea, where you only have a configuration file, and your implementation and it works without no further work. + + + +Here's a taste of some features: + +- human-readable json configuration +- nested routes (*i.e. `/user/:id:` vs. `/user/post/​:id:​`*) +- useful http methods: GET, POST, PUT, DELETE +- manage URL, query and body arguments: + - multipart/form-data + - application/x-www-form-urlencoded + - application/json +- required vs. optional parameters with a default value +- parameter renaming +- generic authentication system (*i.e. you can override the built-in*) +- generic type check (*i.e. implement your types alongside built-in types*) \ No newline at end of file