Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Issues Template #2

Open
umarsalah opened this issue Nov 21, 2021 · 0 comments
Open

Issues Template #2

umarsalah opened this issue Nov 21, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@umarsalah
Copy link
Member

Express Route template

labels: backend, route

Title: METHOD/full-route , eg: POST/login

Description
What route should do

Protected: Yes/No

Required middlewares: if exist

Response:
maybe success or error:
Error :

    {
        status:400,
        message:'Bad reqeust'
    }

Success

 {
     status:200,
     data: [...please fill sample of data] , 
 }

Request body:

 {
      x: "Y"
 }

Validation

{
      x: string
}

Tests: test all potential cases for the route itself.

@umarsalah umarsalah added the documentation Improvements or additions to documentation label Nov 21, 2021
@umarsalah umarsalah pinned this issue Nov 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant