search

schollz / find3

High-precision indoor positioning framework, version 3.
https://www.internalpositioning.com/doc
MIT License
4.65k stars 366 forks source link

Document all of the server endpoints #5

Closed victorhooi closed 6 years ago

victorhooi commented 6 years ago

The documentation should include a list of all the API and front-end endpoints:

I believe these are all in server.go, right?

https://github.com/schollz/find3/blob/d7fa365637509bf31f34167bc08cfc203d687663/server/main/src/server/server.go

I'm happy to take a stab at this, if you provide some pointers on how you'd like it done =).

schollz commented 6 years ago

Yes, I'd be happy if you'd like to try!

I think something like I did previously is fine: https://www.internalpositioning.com/api/

I know there are fancier ways (swagger) and I'm fine with those too, but don't have time to learn them.