Skip to content

docs: add API documentation for backend endpoints - #52

Open
Harshita264 wants to merge 1 commit into
KDeekshita:mainfrom
Harshita264:feat/api-documentation
Open

docs: add API documentation for backend endpoints#52
Harshita264 wants to merge 1 commit into
KDeekshita:mainfrom
Harshita264:feat/api-documentation

Conversation

@Harshita264

Copy link
Copy Markdown
Contributor

Closes #46

Added docs/api.md documenting all current backend endpoints:

  • GET / — serves the main HTML page
  • GET /api/hello — health check endpoint
  • /static/* — static file serving

Documentation includes route, description, response status, content-type, and response body for each endpoint.

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.

Add basic API documentation

1 participant