REST API Status Code Example

Fri, 25 Feb 2022 09:57:46 +0700

Introduction

HTTP status codes are essential in REST APIs as they indicate the outcome of client requests. These standardized codes help clients understand whether their request was successful, requires further action, or encountered an error. Below is an overview of key HTTP status codes categorized by their respective classes.

REST API Success Response Example

Tue, 22 Feb 2022 22:03:47 +0700

Overview

This document provides an example of a successful response from a REST API when creating a new resource. The response follows a structured format, including essential details such as the resource ID, attributes, timestamps, and metadata.

REST API Error Response Example

Tue, 22 Feb 2022 21:57:44 +0700

REST APIs should provide clear and structured error responses to help clients understand and resolve issues effectively. Below are examples of different types of error responses that an API might return.

Single Error Responses

Incorrect Username or Password

{
    "type": "/errors/incorrect-user-pass",
    "title": "Incorrect username or password.",
    "status": 401,
    "detail": "Authentication failed due to incorrect username or password.",
    "instance": "/login/log/abc123"
}

Validation Errors

Title Must Be Defined

{
    "data": null,
    "error": {
        "status": 400,
        "name": "ValidationError",
        "message": "title must be defined.",
        "details": {
            "errors": [
                {
                    "path": ["title"],
                    "message": "title must be defined.",
                    "name": "ValidationError"
                }
            ]
        }
    }
}

Name Must Be At Most 50 Characters

{
    "data": null,
    "error": {
        "status": 400,
        "name": "ValidationError",
        "message": "name must be at most 50 characters",
        "details": {
            "errors": [
                {
                    "path": ["name"],
                    "message": "name must be at most 50 characters",
                    "name": "ValidationError"
                }
            ]
        }
    }
}

This Attribute Must Be Unique

{
    "data": null,
    "error": {
        "status": 400,
        "name": "ValidationError",
        "message": "This attribute must be unique",
        "details": {
            "errors": [
                {
                    "path": ["name"],
                    "message": "This attribute must be unique",
                    "name": "ValidationError"
                }
            ]
        }
    }
}

Authentication Errors

No Authorization Provided

{
    "data": null,
    "error": {
        "status": 403,
        "name": "ForbiddenError",
        "message": "Forbidden",
        "details": {}
    }
}

Invalid Authentication

{
    "data": null,
    "error": {
        "status": 401,
        "name": "UnauthorizedError",
        "message": "Missing or invalid credentials",
        "details": {}
    }
}

Multiple Errors

Name and Title Must Be Defined

{
    "data": null,
    "error": {
        "status": 400,
        "name": "ValidationError",
        "message": "2 errors occurred",
        "details": {
            "errors": [
                {
                    "path": ["name"],
                    "message": "name must be defined.",
                    "name": "ValidationError"
                },
                {
                    "path": ["title"],
                    "message": "title must be defined.",
                    "name": "ValidationError"
                }
            ]
        }
    }
}

Field-Specific Validation Errors

Field Too Short

{
  "placement": "field",
  "title": "value too short",
  "detail": "field username must be at least 4 symbols",
  "location": "username",
  "field": "username",
  "code": "validation.min",
  "expression": "min",
  "argument": "4",
  "traceid": "74681b27-b1ea-454d-9847-d27059e19119",
  "stacktraces": [
 {
   "file": "model/response.go",
   "function": "model.(*ErrorMessage).LogStacktraceWithErr",
   "linenumber": 22,
   "realerror": null
 },
 {
   "file": "helpers/validator.go",
   "function": "helpers.Validator",
   "linenumber": 58,
   "realerror": null
 },
 {
   "file": "handlers/registration.go",
   "function": "handlers.RegistrationHandler",
   "linenumber": 61,
   "realerror": null
 }
  ]
}

Password and Confirm Password Must Match

{
  "placement": "field",
  "title": "must be equal",
  "detail": "field password is not equal to field confirmpassword",
  "location": "password",
  "field": "password",
  "code": "validation.equal",
  "expression": "equal",
  "argument": "confirmpassword",
  "traceid": "e017ecb2-d72f-4f79-889f-6c42126970a8",
  "stacktraces": [
 {
   "file": "model/response.go",
   "function": "model.(*ErrorMessage).LogStacktraceWithErr",
   "linenumber": 22,
   "realerror": null
 },
 {
   "file": "helpers/validator.go",
   "function": "helpers.Validator",
   "linenumber": 58,
   "realerror": null
 },
 {
   "file": "handlers/registration.go",
   "function": "handlers.RegistrationHandler",
   "linenumber": 61,
   "realerror": null
 }
  ]
}

Incorrect Email Format

{
  "placement": "field",
  "title": "incorrect email format",
  "detail": "field email has incorrect value",
  "location": "email",
  "field": "email",
  "code": "validation.email",
  "expression": null,
  "argument": null,
  "traceid": "cecda6b8-7ce8-4054-8c06-9382320afd78",
  "stacktraces": [
 {
   "file": "model/response.go",
   "function": "model.(*ErrorMessage).LogStacktraceWithErr",
   "linenumber": 22,
   "realerror": null
 },
 {
   "file": "helpers/validator.go",
   "function": "helpers.Validator",
   "linenumber": 58,
   "realerror": null
 },
 {
   "file": "handlers/registration.go",
   "function": "handlers.RegistrationHandler",
   "linenumber": 61,
   "realerror": null
 }
  ]
}

These error responses provide a consistent structure, making it easier for clients to handle errors programmatically and display meaningful messages to users.

REST API Testing Strategy What Exactly Should You Test

Sat, 19 Feb 2022 17:01:42 +0700

API testing is a crucial part of software quality assurance, ensuring that APIs function correctly, securely, and efficiently. This guide details key test actions, test scenario categories, and test flows to ensure a thorough validation of API behavior.

API Test Actions

Each API test involves several key actions:

Postman Example

Fri, 21 Jan 2022 06:21:42 +0700

Introduction

Postman is a popular API testing tool that allows developers to automate and validate API responses efficiently. This guide provides examples of how to use variables, write tests, handle error responses, and perform asynchronous requests in Postman.

Json - Tag - Dimas Maulana

REST API Status Code Example

Introduction

REST API Success Response Example

Overview

REST API Error Response Example

Single Error Responses

Incorrect Username or Password

Validation Errors

Title Must Be Defined

Name Must Be At Most 50 Characters

This Attribute Must Be Unique

Authentication Errors

No Authorization Provided

Invalid Authentication

Multiple Errors

Name and Title Must Be Defined

Field-Specific Validation Errors

Field Too Short

Password and Confirm Password Must Match

Incorrect Email Format

REST API Testing Strategy What Exactly Should You Test

API Test Actions

Postman Example

Introduction