mirror of
https://github.com/1f349/dendrite.git
synced 2024-11-26 13:41:33 +00:00
Create README.md
This commit is contained in:
parent
414ea314a6
commit
b9a4551075
11
src/github.com/matrix-org/dendrite/clientapi/README.md
Normal file
11
src/github.com/matrix-org/dendrite/clientapi/README.md
Normal 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.
|
Loading…
Reference in New Issue
Block a user