char
/
dendrite
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
dendrite/clientapi
History
Neil Alexander fe82e1f725
Separate muxes for public and internal APIs (#1056) 
* Separate muxes for public and internal APIs

* Update client-api-proxy and federation-api-proxy so they don't add /api to the path

* Tidy up

* Consistent HTTP setup

* Set up prefixes properly
 		2020-05-22 11:43:17 +01:00
..
auth Fix #897 and shuffle directory around (#1054) 2020-05-21 14:40:13 +01:00
consumers Fix #897 and shuffle directory around (#1054) 2020-05-21 14:40:13 +01:00
httputil Remove httputil.LogThenError so that the line numbers are reported properly - make error reporting slightly more useful (#879) 2020-03-02 16:20:44 +00:00
jsonerror Roomserver perform join (#1001) 2020-05-04 13:53:47 +01:00
producers Fix #897 and shuffle directory around (#1054) 2020-05-21 14:40:13 +01:00
routing Separate muxes for public and internal APIs (#1056) 2020-05-22 11:43:17 +01:00
threepid Fix #897 and shuffle directory around (#1054) 2020-05-21 14:40:13 +01:00
userutil use go module for dependencies (#594) 2019-05-21 21:56:55 +01:00
README.md use go module for dependencies (#594) 2019-05-21 21:56:55 +01:00
clientapi.go Separate muxes for public and internal APIs (#1056) 2020-05-22 11:43:17 +01:00

README.md

This component roughly corresponds to "Client Room Send" and "Client Sync" on the WIRING diagram. 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.