# README
bcc
bcc is a demo social media API backend.
API Documentation
-md/bcc
exposes a REST API server. The server's GET endpoints take simple query parameters, while POST endpoints expect a JSON body in the request. To get a list of endpoints and their parameters, run bcc -doc
.
TODO
- Implement path parameters for
cmd/bcc
's mux to allow for, for example,GET /timeline/:userID
as a valid endpoint. - Proper testing. This'll require a full mocking of the database to do properly, so it's way out of the scope of this project.
- More endpoint parity, such as deleting posts.
- Full input validation so that, for example, you can't make a comment on a post that doesn't exist.
- Documentation of the structure of data returned from endpoints.
- Authentication with OAuth tokens and the
Authorization
header.