Quantcast
Channel: Active questions tagged rest - Stack Overflow
Viewing all articles
Browse latest Browse all 3655

Documenting APIs - /me endpoints

$
0
0

I have a portfolio where I display my work (mostly backend API stuff with minimal UI to interact with) and am currently documenting the APIs. What I have is a page per project along with the documentation that belongs to it. In my APIs, I use a "base" endpoint named after the resource it works with (/todos, /posts,…). GET /todos would return a list of every todos from the DB, pretty standard stuff. I also use a "base" /me endpoint to be able to return every kind of resource of the current logged in user (that can be posts, todos,… ex: GET /me/todos would return every todos of the current user).

Because I have a page per project / documentation, should I list and document every /me endpoints in a separate page (for example, in my "Profile" page), or should I put them in their respective projects page ? Ex : In my "Todos" project page, I would document every /todos endpoint but also GET /me/todos and so on for every project.

I know this might sound like a stupid question, but it bugs me a little to mix the "base" endpoint of a project (ex: /todos) with this GET /me/todos endpoint (because then the /todos endpoint doesn't seem to be the "base" one anymore). But at the same time, I feel like having this GET /me/todos documented in the "Todos" project page would facilitate navigating and reading the docs.

Could someone point me in the right direction please?


Viewing all articles
Browse latest Browse all 3655

Trending Articles



<script src="https://jsc.adskeeper.com/r/s/rssing.com.1596347.js" async> </script>