Skip to content

Latest commit

 

History

History
27 lines (21 loc) · 1.58 KB

api-desc.md

File metadata and controls

27 lines (21 loc) · 1.58 KB
Raw

What it's?

Simple TODO API to CRUDS (Create, Read, Update, Searsh) the users todos, each user have unique token.

Authentication

In this API we use JWT (JSON Web Token) to authenticate the users, the token is generated when the user is created and is returned in the response. The token is used to authenticate the user in the other endpoints.
The token is sent in the header of the request in the format Authorization: Bearer <token>.
The token doesn't expire, but can be revoked, if the token is revoked the user will not be able to use it anymore, you can revoke the token in the /api/auth/revoke endpoint.

Note (for the endpoints that need authentication)

  • Set Authorization header in the request with the token, else will return 400 Bad Request.
  • The token should start with Bearer and then the token, else will return 400 Bad Request.
  • The token should be valid, else will return 401 Unauthorized.
  • The token should not be revoked, else will return 403 Forbidden.

Rate Limit

The API has a rate limit of 30 burst requests per minute, if you exceed the limit will return 429 Too Many Requests.

Headers

  • x-ratelimit-limit: Your burst size, maximum number of requests you can make in a burst
  • x-ratelimit-remaining: The requests remaining in the current burst, when it reaches 0 the next request will return 429 Too Many Requests.
  • x-ratelimit-reset: The time in seconds when the current burst will be reset.