Skip to content

RashIO-Bangkit-Capstone/backend-rashio

Repository files navigation

RashIO API

Documentation

Endpoints

Method Endpoint Description
GET / Hello world
GET /documentation Documentation
-- -- --
POST /users Create a user (register)
GET /users/{id} Get user data
PUT /users/{id} Update user data
PUT /users/{id}/password Update user password
-- -- --
POST /authentications Create a session (login)
PUT /authentications Update a session (refresh token)
DELETE /authentications Delete a session (logout)
-- -- --
POST /predictions Create a prediction (upload image)
GET /predictions/{userId} Get log predictions from a user
-- -- --
GET /diseases/{nameDiseases} Get disease description
POST /diseases Create a disease description
PUT /diseases/{nameDiseases} Update a disease description
DELETE /diseases/{nameDiseases} Delete a disease description
-- -- --
POST /articles Create an article
GET /articles/ Get all article
GET /articles/{id} Get an article
PUT /articles/{id} Update an article
DELETE /articles/{id} Delete an article

Checklist

Endpoints

  • GET /
  • POST /users
  • GET /users/{id}
  • PUT /users/{id}
  • PUT /users/{id}/password
  • POST /authentications
  • PUT /authentications
  • DELETE /authentications
  • POST /predictions
  • GET /predictions/{userId}
  • POST /diseases
  • GET /diseases/{nameDiseases}
  • PUT /diseases/{nameDiseases}
  • DELETE /diseases/{nameDiseases}
  • POST /articles
  • GET /articles/{id}
  • PUT /articles/{id}
  • PUT /articles/{id}/image
  • DELETE /articles/{id}

Deployment

  • Integrate with Google Cloud Storage Bucket
  • Deploy dev API in GCP
  • Deploy prod API in GCP
  • Deploy ML model in GCP

Postman Testing

  • Feature Users
  • Feature Authentications
  • Feature Predictions
  • Feature Diseases
  • Feature Articles