Rest Api Kullanımı

03.05.2019

JSON Rest API'de aşağıdaki kriterler önem arzetmektedir:

1- NULL yerine boş string gönderilmelidir.

2- Date türü için ISO-8601 formatına göre gönderilmelidir.

3- Multiline string için base64 encoding yapılabilir.

4- Success için aşağıdaki gibi bir sonuç dönülmelidir:

{
    "data": {
        "id":1000,
        "first_name": "Ahmet Yılmaz"
    }
}

Eğer birden fazla sonuç gelecekse aşağıdaki gibi döndürülmelidir:

{
    "data": [{
        "id":1000,
        "first_name": "Ahmet Yılmaz"
    },
    {
        "id":1001,
        "first_name": "Hakkı Yılmaz"
    }]
}

5- Naming Convention olarak, bu örneklerde görüldüğü üzere bir property birden fazla kelimeden oluşuyorsa, snake_case dediğimiz teknik kullanılması tavsiye edilmektedir. Ancak Java ve Javascript'te ise camelCase kullanılması tavsiye edilmektedir.

6- Error sonuç için aşağıdaki gibi bir sonuç dönülmelidir:

{
    "error": {
        "code": 404,
        "message: "ID not found"
    }
}

Aynı şekilde birden fazla dönülecekse aşağıdaki gibi dönülmesi tavsiye edilmektedir: Burada dikkat edilmesi gereken husus şudur: Parametre error yerine errors şeklinde kullanıldı.

{
    "errors": [{
        "code": 404,
        "message: "ID not found"
    },
    {
        "code": 400
        "message: "Bad request"
    }]
}

7- Rest API de kullanılması tavsiye edilen HTTP status kodları şunlardır:

- 200 -> OK

- 201 -> Created

- 204 -> Deleted gibi işlemlerde boş içerik döndermek için kullanılmaktadır.

- 304 -> Not Modified

- 400 -> Bad Request

- 401 -> Unauthorized

- 403 -> Forbidden

- 404 -> Not found

- 500 -> Internal server error. (Bu hata kodunu kullanıcıya iletmemek en doğru yöntemdir)

8- Diğer önemli bilgiler için https://blog.mwaysolutions.com/2014/06/05/10-best-practices-for-better-restful-api/

© 2019 Tüm Hakları Saklıdır. Codesenior.COM