Rework API operation paths and method display - Githubissues

joffrey-bion / livedoc

A not-so-annotation-based documentation generator for REST and websocket services

MIT License

5 stars 2 forks source link

Rework API operation paths and method display #78

Open joffrey-bion opened 6 years ago

joffrey-bion commented 6 years ago

Currently, API operations are displayed using the first path followed by the HTTP method(s). This is not ideal:

all paths should be documented
the method should be displayed first, as it is nicer visually to see "GET /something" rather than "/something GET"

2 problems:

multiple paths don't fit well on the screen, maybe we could dispaly the list vertically, or only show the other ones on hover
putting the method first makes staking them look bad, because it shifts the beginning of the first path to the right. Maybe we could display the first method, followed by "...", which would be displayed on hover.