Skip to content

docs: add example curl commands to API reference - #75

Open
TrueFurina wants to merge 1 commit into
codepath:mainfrom
TrueFurina:docs/api-curl-examples
Open

docs: add example curl commands to API reference#75
TrueFurina wants to merge 1 commit into
codepath:mainfrom
TrueFurina:docs/api-curl-examples

Conversation

@TrueFurina

Copy link
Copy Markdown

Summary

Per #47: docs/API.md described every endpoint but had no example invocations, so first-time developers couldn't quickly verify the API works.

Changes

  • docs/API.md: added example curl commands for every endpoint:
    • GET /health
    • POST /auth/register, POST /auth/login (with example JWT response note)
    • POST /profiles, GET /profiles/{id}, DELETE /profiles/{id}
    • POST /reviews, GET /reviews/{id}, GET /reviews (with pagination query example)
  • Authenticated endpoints show Authorization: Bearer <jwt>; example request bodies use the documented payload shapes

Acceptance criteria

  • Every endpoint in API.md has an example invocation
  • Examples use the real endpoint paths and payloads from the codebase

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.

1 participant