search

transportapi / api-console

A Web Component for an interactive REST console based on RAML files
Other
0 stars 0 forks source link

UX to expand out API endpoint docs #6

Open harry-wood opened 8 years ago

harry-wood commented 8 years ago

To see actual endpoint docs you have to click to expand out the section. e.g. you see "/uk/bus/stop/{atcocode}/live.json" and then have to click on the little tab on the right hand side which says "GET". Even to me, having used to docs a lot, I find that UX counter-intuitive. Why can't I click on the "/uk/bus/stop/{atcocode}/live.json" title?

....and given that all our endpoints are GET, could we actually remove those GET tabs? For a noddy API user, talk of GET is unnecessarily confusing and cluttering.

Could be an idea to suggest upstream

madwort commented 8 years ago

I agree that ideally the title would be clickable, but I don't think it's a massive problem - looking at those docs you expect something to be clickable so just have a little search. Not ideal but not blocking for me. Feature request upstream?

I think it needs to say GET.

mgogov commented 8 years ago

I see the point on clickability IMO, it's not that painful to have those GETs.

It also kindof makes it a bit more clear that what we support is HTTP GET and not some other HTTP verb.

Given the importance of other API console issues, I'd say this is very low priority.