akinbezatoglu / survey-builder

A survey management system that users can tailor according to their wishes and needs.

A Survey Management Application on Huawei Cloud

Project Architecture

API Gateway Endpoints with Serverless Backend (Functions)

This list shows which endpoints and HTTP methods will trigger which serverless functions in the backend.

1. functions/register

   POST /api/v1/auth/signup

   This API endpoint is designed to handle user registration. It expects a POST request containing user information, likely in the request body, for creating a new user account.

2. functions/login

   POST /api/v1/auth/login

   This API endpoint is used for user login. It expects a POST request containing user credentials, typically in the request body, to authenticate an existing user.

3. functions/userprofile

   GET /api/v1/profile

   This API endpoint retrieves a user's profile information. It expects a GET request and likely requires some form of authentication (e.g., an access token) to be included in the request header to authorize access to the user's private profile data.

4. functions/formcreate

   POST /api/v1/f

   This API endpoint handles form submissions. It expects a POST request containing form data, typically in the request body, to create a form.

5. functions/formdelete

   DELETE /api/v1/f/{id}

   This API endpoint is used to delete a specific form. It expects a DELETE request targeting a URL with a placeholder for the form identifier.

6. functions/formget

   GET /api/v1/f/{id}

   This API endpoint retrieves information about a specific form. It expects a GET request targeting a URL with a placeholder for the form identifier.

7. functions/formgetall

   GET /api/v1/f

   This API endpoint retrieves a list of forms accessible to the user. It expects a GET request and might require some form of authentication (e.g., access token) to be included in the request header.

8. functions/formput

   PUT /api/v1/f/{id}

   This API endpoint allows updating an existing form. It expects a PUT request targeting a URL with a placeholder for the form identifier and includes the updated form data in the request body.

9. functions/formresponseget

   GET /api/v1/f/{id}/response

   This API endpoint retrieves responses submitted to a specific form. It expects a GET request targeting a URL with a placeholder for the form identifier.

10. functions/formviewget

    GET /api/v1/f/{id}/view

    This API endpoint retrieves information about a specific form for viewing purposes. It expects a GET request targeting a URL with a placeholder for the form identifier.

11. functions/formviewpost

    POST /api/v1/f/{id}/answer

    This API endpoint allows users to submit answers for a specific form. It expects a POST request to be sent to the designated URL.

12. functions/questiondelete

    DELETE /api/v1/f/{id}/question/{id}

    This API endpoint permanently deletes a specific question from a form. It expects a DELETE request to be sent to the designated URL.

13. functions/questionpost

    POST /api/v1/f/{id}/question

    This API endpoint creates a new question within a specified form. It expects a POST request to be sent to the designated URL.

14. functions/questionpostcopy

    POST /api/v1/f/{id}/question/{id}/copy

    This API endpoint duplicates an existing question within a form, creating a new copy of the question. It expects a POST request to be sent to the designated URL.

15. functions/questionput

    PUT /api/v1/f/{id}/question/{id}

    This API endpoint updates an existing question within a form. It replaces the entire question with the new data provided in the request body. It expects a PUT request to be sent to the designated URL.

16. functions/optiondelete

    DELETE /api/v1/f/{id}/question/{id}/option/{id}

    This API endpoint permanently deletes a specific option from within a question on a form. It expects a DELETE request to be sent to the designated URL.

17. functions/optionpost

    POST /api/v1/f/{id}/question/{id}/option

    This API endpoint creates a new option within a specified question on a form. It expects a POST request to be sent to the designated URL.

18. functions/optionput

    PUT /api/v1/f/{id}/question/{id}/option/{id}

    This API endpoint updates an existing option within a question on a form. It replaces the entire option with the new data provided in the request body. It expects a PUT request to be sent to the designated URL.