Skip to main content

Rest API desing [DSP2017 #02]

Rest API best practices

During creating an http api we should remember about few rules.
  1. As a API designers we must know how to name our endpoints. When we have a library which contains users and their books. As a collection we should use a plural form of verb like books and users. Below we can find examples of endpoints for certain activity and strict HTTP methods
    • Add new book: /users/{userId}/books/{bookId} POST
    • Get book: /users/{userId}/books/{bookId} GET
    • Edit book: /users/{userId}/books/{bookId} PUT
    • Remove book: /users/{userId}/books/{bookId} DELETE 
  2. Status codes
    • 200 OK
    • 201 Created
    • 202 Accepted - request has been accepted but not completed.
    • 204 Non content - the request is correct but no content in response body.
    • 400 Bad request
    • 401 Unauthorized
    • 403 Forbidden
    • 404 Not found
    • 408 Request time out
    • 409 - Conflict - duplicate data or invalid data state would occur.
    • 500 Internal server error
    • 501 Not implemented
    • 503 Service unavailable   
I think that above list is the most important when we start with creating API. If we will keep in mind this rules our work will be easiest and more professional :) For further learning please visit the resource materials.

Resources:
Labels:

Comments

Post a Comment

Popular posts from this blog

Types of tests [DSP2017 #04]

As a java developer with more than 3 years of experience I had opportunity of participating in few projects. To be honest only in a last one a testing strategy is on high level.  I encourage you for introduce and put more pressure on testing strategy during a delivery process. As with all new things the beginnings are difficult but I'm sure that it is worth. As almost testers know undermentioned pyramid I need to put it for people who have not seen it. In a big amount of projects we can meet this pyramid in inverted order. What can impact of quality of a system. For example when we have a lot of manual tests it is boring for users and sometimes they can be skipped what can missed bug. So in the lowest level we see the Unit tests and the count of this should be the bigger and on the highest level, there are manual tests. As we can expect the count should of them should be the lowest. A few words about each of them: Unit tests - should be quick and small. They check jus...
2 comments
Read more

Oracle Certified Associate Java SE 8 Programmer I: Exam 1Z0-808 [DSP2017 #05]

  Hello and sorry for absence during last weeks. This time was very busy because I had to prepare myself for OCA certification. In this post I want to write few word about: what I've done how it looks what I will improve next time  I've read one book from beginning to the end. It was   OCA Java SE 8 Programmer I Certification Guide MALA GUPTA   I think that it is good book for gain knowledge about base java. There is a lot of examples, very detail description. Form point of exam just reading and making the tests is not enough. The test inside this book are not so easy but they don't cover real exam. Next books which were only source of mock tests: OCA / OCP Java SE 8 Programmer Practice Tests OCA: Oracle Certified Associate Java SE 8 Programmer I Study Guide: Exam 1Z0-808   The mocks in the first position are very easy and so short. In real exam the examples of code was so longer and requires more concentration. During the preparation I was...
Post a Comment
Read more

How to start with Android development [DSP2017 #07]

In this part I want to show how I started with a first app. My previous experience with creating an Android application was about 4-5 years ago. I've created one or two simple applications during my studies and forgot about this topic. Today when I wanted to create a new app I needed to start from beginning. First of all I need to install tools: Android Studio (I use Intellij with Android extension). Android SDK - I used the sdkmanager but during Android Studio installation sdk should be installed. If you have 64 bits system you need to check: Required libraries for 64-bit machines . If you have installed all above tools you should be able to create simple Android project and run it on your phone. Yes, like always I met few problems with run the application on my phone. #1 The adb can not find my device. Solution : turn phone as MTP mode. 2# Error:Execution failed for task ':app:processDebugResources'. > com.android.ide.common.process.ProcessException:...
Post a Comment
Read more