mirrors/dendrite
1
0
Fork 0
mirror of https://github.com/matrix-org/dendrite.git synced 2024-11-22 14:21:55 -06:00
Code Issues Packages Projects Releases Wiki Activity

Create README.md

Browse source
This commit is contained in:
Kegsay 2017-03-13 15:56:26 +00:00 committed by GitHub
parent 414ea314a6
commit b9a4551075
1 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
src/github.com/matrix-org/dendrite/clientapi/README.md Normal file
View file

@ -0,0 +1,11 @@
This component roughly corresponds to "Client Room Send" and "Client Sync" on [the WIRING diagram](https://github.com/matrix-org/dendrite/blob/master/WIRING.md).
This component produces multiple binaries.
## Internals
- HTTP routing is done using `gorilla/mux` and the routing paths are in the `routing` package.
### Writers
- Each HTTP "write operation" (`/createRoom`, `/rooms/$room_id/send/$type`, etc) is contained entirely to a single file in the `writers` package.
- This file contains the request and response `struct` definitions, as well as a `Validate() bool` function to validate incoming requests.
- The entry point for each write operation is a stand-alone function as this makes testing easier. All dependencies should be injected into this function, including server keys/name, etc.