search

manu-chroma / username-availability-checker

Live at : https://username-check.herokuapp.com/
95 stars 37 forks source link

Add usernameapi.raml #73

Open seeeturtle opened 6 years ago

seeeturtle commented 6 years ago

This raml file describe api specification for username_api

Closes https://github.com/manu-chroma/username-availability-checker/issues/15

manu-chroma commented 6 years ago

why not username_api.raml. That would be cleaner, imo

seeeturtle commented 6 years ago

np if you want

manu-chroma commented 6 years ago

is there any test we need for RAML service? @jayvdb

seeeturtle commented 6 years ago

@manu-chroma, can I just merge this? I think this doesn't seem to have much impact.

jayvdb commented 6 years ago

Ideally we use a raml client to test it works.

The front-end could also use a raml client to negotiate the API of the back-end.

If neither of those, we need to at least do a manual check of using the raml before merging.

seeeturtle commented 6 years ago

@jayvdb, I tried to test raml file with ramlient with the code below: client.check.website("github").username("seeeturtle").get()

but it always request /check/{website}/{username} not /check/github/seeeturtle

Anybody know what's wrong?

@manu-chroma

seeeturtle commented 6 years ago

@jayvdb @manu-chroma I can't find out why ramlient doesn't format the given uri. Is it because the library doesn't support well or is the syntax wrong?

seeeturtle commented 6 years ago

^@jayvdb