Standardize API - Githubissues

anyaudio / anyaudio-server

:musical_note: Simple server to search youtube and give direct audio download and stream links

91 stars 19 forks source link

Closed singhpratyush closed 8 years ago

singhpratyush commented 8 years ago

Currently, the API calls are like /g/<video id> and /search?q=<query>.

Make it more standard like

/api/v1/g/<video id> (or /api/v1/g/<video id>.json, /api/v1/g/<video id>.xml, etc. )
/api/v1/search?q=<query> (possibly with more parameters like offset and limit)

The response needs to be standardized too.

aviaryan commented 8 years ago

Cool. Let's first move the APIs under /api/v1 namespace. I like /api/v1/g/<video id> over the json suffixed counterpart.

@singh-pratyush96 How do you propose to standardize responses ?

singhpratyush commented 8 years ago

I will create docs/api/v1/API.md mentioning the plan. Changes will be made upon discussion.

aviaryan commented 8 years ago

@singh-pratyush96 Ok. Please use your fork for making changes and then send PRs.