Skip to content

docs: add centralized REST API reference to README#1449

Open
Vaishnavi10706 wants to merge 1 commit into
aryandas2911:mainfrom
Vaishnavi10706:docs/add-rest-api-reference-readme
Open

docs: add centralized REST API reference to README#1449
Vaishnavi10706 wants to merge 1 commit into
aryandas2911:mainfrom
Vaishnavi10706:docs/add-rest-api-reference-readme

Conversation

@Vaishnavi10706
Copy link
Copy Markdown
Contributor

📌 Description

This PR adds a centralized REST API Reference section to the README to improve developer onboarding and backend integration.

Previously, contributors had to inspect backend route files manually to discover available endpoints and understand authentication requirements. This update provides a single source of truth for the project's API documentation.

🔗 Related Issue

Closes #1422

🛠 Changes Made

  • Added a new REST API Reference section to README.md

  • Documented available API endpoints for:

    • Authentication
    • Tasks
    • Routines
    • Analytics
  • Included HTTP methods, endpoint paths, authentication requirements, and endpoint descriptions

  • Added JWT Authorization header usage example

  • Verified documented routes against existing backend route files

  • Kept changes limited to documentation only with no backend or frontend code modifications

✅ Checklist

  • Code runs locally
  • Followed project structure
  • No console errors
  • Properly tested changes
  • Linked the issue

🚀 Notes for Reviewers

  • This PR only updates README.md.
  • No application logic, API behavior, or project configuration was modified.
  • Documentation was aligned with the existing backend route structure to improve maintainability and contributor experience.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs]: Add REST API Endpoint Reference to README

1 participant