Skip to content

[ELUSoC'26] Create Comprehensive API Documentation Guide #196

@KGFCH2

Description

@KGFCH2

Problem

There is no centralized guide documenting backend API endpoints, payload requirements, or response schemas, which makes it harder for new contributors to get started.

Current Behavior

Developers must inspect the router and controller code to understand API structures.

Why This Improvement Is Needed

Clear API documentation improves the onboarding process for new contributors and simplifies frontend-backend integration.

Proposed Solution

Create docs/API_DOCUMENTATION.md detailing all backend endpoints, authentication flows, and JSON schemas.

Expected Outcome

A complete, easy-to-read API reference guide is added to the project repository.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions