如何對Web服務的API進行Unit Test?

為什么要求對Web服務的API進行測試?請移步這里Java中幾種Unit Test場景

假設:我們需要需要對前端提供一個API,這個API的功能是:通過結(jié)果關(guān)鍵字查詢產(chǎn)品的描述信息萧求;

目錄:
1,建立API契約
2, API代碼
3, 測試代碼:測試參數(shù)顶瞒,測試找到資源情況下的返回結(jié)果夸政,測試未找到資源是的返回結(jié)果


建立API的契約:

建議使用Swagger 的yaml格式來定義,這里為了易讀榴徐,使用純中文描述.

    GET請求
    http://localhost:8888/api/products/{productId}

查詢參數(shù):

          countryCode: String

返回結(jié)果:

200: 找到了相關(guān)資源
           {
                     "name" : "ABC",
                     "countryCode" : "US",
                     "description" : "Super ABC"
           }

404:  未找到資源
            {
                   "message": "Not found."
            }

API代碼

ProductResource

@RestController
@RequestMapping("/api/products")
public class ProductResource {
    
    @Autowired
    private ProductService productService;

    @GetMapping("/{productId}
    public Product query(@PathVariable("productId") String productId, 
                         @RequestParam("countryCode") String countryCode) thrown NotFoundException {
        productService.query(productId, countryCode);
    }
}

ProductService

@Service
public class ProductService {

    public ProductDTO query(String productId, String countryCode) throws NotFoundException {
        if ("ABC".equals(productId) && "US".equals(countryCode)) {
            return new ProductDTO("ABC", "US", "Super ABC");
        }
        throw new NotFoundException("Not found");
    }
}

ProductDTO

@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
public class ProductDTO {
    private String name;
    private String countryCode;
    private String description;
}

測試代碼

測試參數(shù):should_response_4XX_when_country_code_is_empty()
測試找到資源情況下的返回結(jié)果:should_response_expected_product_information_when_find_product_by_product_id_and_country_code()
測試未找到資源是的返回結(jié)果:should_response_404_when_product_not_found_by_produt_id_and_country_code()

@RunWith(SpringRunner.class)
@SpringBootTest(class=Application.class)
public class ProductResourceTest {

    private static final ObjectMapper OBJECT_MAPPER = new ObjectMapper();

    protected MockMvc mockMvc;

    @Autowired
    private ProductResource productResource;

    @Autowired
    private ProductService productService;

    @Autowired
    private GlobalEntityExceptionHandler globalEntityExceptionHandler;

   @BeforeClass
   public static void setup() {
        this.mockMvc = MockMvcBuilders.standaloneSetup(productResource)
                          .setControllerAdvice(globalEntityExceptionHandler)
                          .build();
   }
   

    @Test
    public void should_response_4XX_when_country_code_is_empty() {
        mockMvc.perform(
               get("/api/products/ABC")
                   .contentType(MediaType.APPLICATION_JSON))
           .andExpect(status().is4xxClientError());
    }


    @Test
    public void should_response_expected_product_information_when_find_product_by_product_id_and_country_code() {
        String expectedResult = OBJECT_MAPPER.writeValueAsString(ProductDTO.builder()
            .name("ABC")
            .countryCode("US");
            .description("Super ABC")
            .build());

        mockMvc.perform(
               get("/api/products/ABC")
                   .contentType(MediaType.APPLICATION_JSON)
                   .param("countryCode", "US"))
           .andExpect(status().isOk())
           .andExpect(content().contentTypeCompatibleWith(MediaType.APPLICATION_JSON))
           .andExpect(content().String(expectedResult));
    }


    @Test
    public void should_response_404_when_product_not_found_by_produt_id_and_country_code() {
      String expectedResult = "{\"message\":\"\"}";

        mockMvc.perform(
               get("/api/products/AAA")
                   .contentType(MediaType.APPLICATION_JSON)
                   .param("countryCode", "GB"))
           .andExpect(status().isNotFound())
           .andExpect(content().contentTypeCompatibleWith(MediaType.APPLICATION_JSON))
           .andExpect(content().String(expectedResult));
    }
}
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末守问,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子坑资,更是在濱河造成了極大的恐慌耗帕,老刑警劉巖,帶你破解...
    沈念sama閱讀 223,002評論 6 519
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件袱贮,死亡現(xiàn)場離奇詭異仿便,居然都是意外死亡,警方通過查閱死者的電腦和手機攒巍,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 95,357評論 3 400
  • 文/潘曉璐 我一進店門嗽仪,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人柒莉,你說我怎么就攤上這事闻坚。” “怎么了兢孝?”我有些...
    開封第一講書人閱讀 169,787評論 0 365
  • 文/不壞的土叔 我叫張陵窿凤,是天一觀的道長。 經(jīng)常有香客問我跨蟹,道長雳殊,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 60,237評論 1 300
  • 正文 為了忘掉前任喷市,我火速辦了婚禮相种,結(jié)果婚禮上威恼,老公的妹妹穿的比我還像新娘品姓。我一直安慰自己寝并,他們只是感情好,可當我...
    茶點故事閱讀 69,237評論 6 398
  • 文/花漫 我一把揭開白布腹备。 她就那樣靜靜地躺著衬潦,像睡著了一般。 火紅的嫁衣襯著肌膚如雪植酥。 梳的紋絲不亂的頭發(fā)上镀岛,一...
    開封第一講書人閱讀 52,821評論 1 314
  • 那天,我揣著相機與錄音友驮,去河邊找鬼漂羊。 笑死,一個胖子當著我的面吹牛卸留,可吹牛的內(nèi)容都是我干的走越。 我是一名探鬼主播,決...
    沈念sama閱讀 41,236評論 3 424
  • 文/蒼蘭香墨 我猛地睜開眼耻瑟,長吁一口氣:“原來是場噩夢啊……” “哼旨指!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起喳整,我...
    開封第一講書人閱讀 40,196評論 0 277
  • 序言:老撾萬榮一對情侶失蹤谆构,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后框都,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體搬素,經(jīng)...
    沈念sama閱讀 46,716評論 1 320
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 38,794評論 3 343
  • 正文 我和宋清朗相戀三年瞬项,在試婚紗的時候發(fā)現(xiàn)自己被綠了蔗蹋。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 40,928評論 1 353
  • 序言:一個原本活蹦亂跳的男人離奇死亡囱淋,死狀恐怖猪杭,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情妥衣,我是刑警寧澤皂吮,帶...
    沈念sama閱讀 36,583評論 5 351
  • 正文 年R本政府宣布,位于F島的核電站税手,受9級特大地震影響蜂筹,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜芦倒,卻給世界環(huán)境...
    茶點故事閱讀 42,264評論 3 336
  • 文/蒙蒙 一艺挪、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧兵扬,春花似錦麻裳、人聲如沸口蝠。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,755評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽妙蔗。三九已至,卻和暖如春疆瑰,著一層夾襖步出監(jiān)牢的瞬間眉反,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,869評論 1 274
  • 我被黑心中介騙來泰國打工穆役, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留寸五,地道東北人。 一個月前我還...
    沈念sama閱讀 49,378評論 3 379
  • 正文 我出身青樓耿币,卻偏偏與公主長得像播歼,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子掰读,可洞房花燭夜當晚...
    茶點故事閱讀 45,937評論 2 361

推薦閱讀更多精彩內(nèi)容