diff options
| author | curly <curlybryce@protonmail.com> | 2023-02-07 08:44:42 -0700 |
|---|---|---|
| committer | curly <curlybryce@protonmail.com> | 2023-02-07 08:44:42 -0700 |
| commit | 8d66325e8886768f125e07790d5d4311dbaf3f03 (patch) | |
| tree | ff843073835bcef54720f5adb1f905a404cc8f32 /README.md | |
| parent | a9a90ce1ed7882c3b929bdfd537de44615b88f0b (diff) | |
| download | rocket_test-8d66325e8886768f125e07790d5d4311dbaf3f03.tar.gz rocket_test-8d66325e8886768f125e07790d5d4311dbaf3f03.tar.bz2 rocket_test-8d66325e8886768f125e07790d5d4311dbaf3f03.zip | |
doc + added routes
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..95e8f7e --- /dev/null +++ b/README.md @@ -0,0 +1,57 @@ +# API +The api is available on `/api`. + +GET `/` +Gets information about the server +- Return type: JSON +- Returns: <information> + +GET `/ping` +Pings the server +- Return type: JSON +- Returns: pong + +GET `/create_user/<name>` +Creates a new user with name +- Return type: JSON +- Returns: <user> + +GET `/get_user/<id>` +Gets a user from id +- Return type: JSON +- Returns: <user> + +GET `/get_user_by_name/<name>` +Gets a user from name +- Return type: JSON +- Returns: <user> + +GET `/get_message/<id>` +Gets a message by id +- Return type: JSON +- Returns: <message> + +GET `/get_message_id_newest` +Gets the newest message id +- Return type: JSON +- Returns: <message_id> + +GET `/get_message_id_list/<from_id>/<to_id>` +Gets a list of messages from_id to to_id inclusive +- Return type: JSON +- Returns: <Array<message_id>> + +GET `/send_message/<user_id>/<message>` +Sends a message +- Return type: JSON +- Returns: <message_id> + +GET `/send_reply/<user_id>/<message_id>/<message>` +Sends a reply to a message +- Return type: JSON +- Returns: <message_id> + +GET `/delete_message/<message_id>` +Deletes a message +- Return type: JSON +- Returns: Deleted
\ No newline at end of file |