API documentation

[detjensrobert]

Due Date: ASAP Prerequisites: #1 Estimated time: 1h

We need to agree on the structure of the server API so the client can request data. Something like site.com/api/stockdata?ticker=TICKER, etc

API Events

Requests

• [ ] Stock data
• [ ] Stock prediction
• [ ] Is this stock saved to the current user?
• [ ] What are the stocks this user has saved?

  Posts

• [ ] Save stock to current user
• [ ] Login
• [ ] New accounr

[lyellread]

@detjensrobert I found this and this(better). Looks like we should use .../api/stockdata/$TICKER for example. How does this sound.

[detjensrobert]

and account stuff under /api/accounts/$USN, e.g. to add a stock to an account?

Works for me.

[lyellread]

and account stuff under /api/accounts/$USN, e.g. to add a stock to an account?

I would go with /api/stockadd/account/stock,

[detjensrobert]

Gonna update the readme with the api docs on api-docs