Tahinli/acapair_chat_api
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: 📝 exposed urls

Browse source
This commit is contained in:
Ahmet Kaan GÜMÜŞ 2024-05-27 01:32:54 +03:00
parent fb951c4ae7
commit e67aee396f
2 changed files with 44 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -1,2 +1,24 @@
# acapair_chat_api
Acapair Chat API
[![Rust Build && Test](https://github.com/Acapair/acapair_chat_api/actions/workflows/rust.yml/badge.svg)](https://github.com/Acapair/acapair_chat_api/actions/workflows/rust.yml)
## Exposed URLs
> ':' means they are variable.
Alive Ping(get): "/"
---
Send Message(post): "/send"
| Body Fields | Example Values |
| -------- | ------- |
| "room_id" | "Tahinli's Room -1" |
| "username" | "Tahinli" |
| "message" | "Hi!" |
---
Receive Message(get): "/receive/:room_id"