Jak przetestować API za pomocą Pythona i JavaScript

Jest cienka granica między wyborem interfejsu programowania aplikacji (API) a podjęciem decyzji, czy można z nim pracować, czy nie. Większość interfejsów API REST ma ogólną architekturę i wątek wspólnej ścieżki żądania. Ale niektóre API odbiegają od standardu. W konsekwencji stają się trudne w użyciu.

Dlatego przed zbudowaniem całego oprogramowania na interfejsie API, musisz przeprowadzić kontrolę jakości i upewnić się, że działa poprawnie. Czym więc jest testowanie API i jak możesz przetestować API?

Co to jest testowanie API?

Testowanie API obejmuje wstępną ocenę funkcjonalności, bezpieczeństwa, skalowalności, szybkości i nie tylko API, aby sprawdzić, czy jest to idealne rozwiązanie dla programu, który chce z niego korzystać. Ale powierzchownie może to obejmować testowanie, aby sprawdzić, czy wysyła odpowiednie odpowiedzi, gdy wysyłasz żądania za pośrednictwem różnych punktów końcowych.

W zależności od jego struktury, podczas testowania interfejsu API będziesz wysyłać żądania (Get, Post, Update lub Delete) do odpowiednich punktów końcowych. Istnieje wiele metryk do sprawdzenia podczas testowania API. Ale na poziomie początkującym chcesz sprawdzić integralność interfejsu API na podstawie jego kodu stanu i upewnić się, że pobiera i akceptuje poprawne dane.

W tym celu, podobnie jak w przypadku każdego żądania internetowego, interfejs API może zwrócić kod stanu 200, 400 lub 500, a nawet inny.

Większość interfejsów API używa odpowiedzi JSON do obsługi swoich ładunków. W zależności od celu inni mogą akceptować i odpowiadać za pomocą ładunków XML, wieloczęściowych lub HTML.

Jak przetestować API za pomocą Pythona i JavaScript

Chociaż w Internecie istnieje wiele narzędzi do testowania interfejsu API graficznego interfejsu użytkownika (GUI), interfejs API można oceniać bardziej krytycznie za pomocą pisanych skryptów.

API informuje w swojej dokumentacji, jakiego rodzaju żądania dopuszcza i dostarcza im odpowiednie punkty końcowe. Możesz więc je pobrać i przetestować za pomocą odpowiednich metod żądań.

Powiązane: Co to jest REST API i jak możesz pobrać dane do swojej aplikacji lub witryny?

W przeciwieństwie do faktycznej fazy produkcyjnej, testowanie API jest surowe. Dzięki temu nie potrzebujesz tak dużej szczegółowości, jak podczas uruchamiania interfejsu API w środowisku produkcyjnym. Chociaż istnieją różne typy testowania interfejsu API, w tym artykule skupimy się bardziej na testach walidacji odpowiedzi.

W tym samouczku przetestujemy fałszywy interfejs API sklepu, korzystając z biblioteki pobierania JavaScript i biblioteki żądań Pythona . Robiąc to, przetestujemy punkty końcowe pod kątem pobierania, publikowania, aktualizowania i usuwania danych.

Jak przetestować punkt końcowy Get API za pomocą JavaScript

Tak jak używałbyś go w środowisku produkcyjnym, możesz przetestować API w JavaScript używając Axios lub metody fetch .

Aby uzyskać status odpowiedzi z interfejsu API za pomocą funkcji fetch :

fetch('https://fakestoreapi.com/products', ).then(res =>{ console.log(res) })

Powyższe żądanie zwraca stan 200, jeśli jest poprawną odpowiedzią. Po pomyślnym przesłaniu żądania możesz zażądać danych w czasie rzeczywistym z interfejsu API.

Pobierzmy dane z tego API:

fetch('https://fakestoreapi.com/products', ).then(res =>{ if (res.ok){ return res.json() } }).then(response=>{ console.log(response) }).catch(err => console.log(err))

Odpowiedź na powyższy kod pobierania wygląda tak:

Aby np. poznać cenę wszystkich produktów, możesz skorzystać z funkcji mapy :

fetch('https://fakestoreapi.com/products', ).then(res =>{ if (res.ok){ return res.json() } }).then(response=>{ response.map(data =>{ console.log(data.price) }) // console.log(response) }).catch(err => console.log(err))

Powyższe rejestruje następujące dane wyjściowe:

Testowanie punktu końcowego Get za pomocą Pythona

Jak wspomniano wcześniej, Python używa również biblioteki żądania, aby uzyskać dostęp do danych API.

Aby sprawdzić status odpowiedzi w tym przypadku:

import requests data = requests.get('https://fakestoreapi.com/products') print(data.status_code)

Rejestrowanie danych, tak jak to zrobiliśmy powyżej, zwraca odpowiedni status. Jednak w tym przypadku jest to 200.

Teraz zdobądźmy te same dane za pomocą Pythona, które zrobiliśmy podczas korzystania z JavaScript:

import requests data = requests.get('https://fakestoreapi.com/products') myData = data.json() print(myData)

Wynik powyższego wygląda tak:

Możesz uzyskać określone dane za pomocą pętli for .

Aby uzyskać ceny produktów, na przykład:

import requests data = requests.get('https://fakestoreapi.com/products') myData = data.json() indexes = 0 for i in myData: goods = myData[indexes] indexes +=1 print(goods["price"])

Oto jak wygląda wynik:

Testowanie punktu końcowego posta za pomocą JavaScript

Po przetestowaniu i sprawdzeniu, że żądanie Get działa, w zależności od celu i tego, co oferuje API, możesz sprawdzić, czy możesz również wstawić do niego dane.

W przeciwieństwie do sposobu, w jaki wykonujesz żądanie Get, żądanie Post akceptuje ładunek. Dodatkowo musisz określić, że jest to żądanie postu:

// Specify the payload let payload = { title: 'new product', price: 13.5, description: 'test description', image: '', category: 'electronic' } fetch('https://fakestoreapi.com/products', { method: "Post", headers:{ 'Content-Type': 'application/json' }, body: JSON.stringify(payload) //convert the payload to JSON } ).then(res =>{ if (res.ok){ console.log(res.status) return res.json() } }).then(response => { console.log(response) }).catch(err => console.log(err))

Powyższy kod rejestruje kod stanu odpowiedzi i nowe informacje wstawiane po uruchomieniu. Dzięki temu dowiesz się, czy Twoja prośba została zrealizowana, czy nie. Zazwyczaj, jeśli kod stanu to 200, interfejs API ma prawidłowy punkt końcowy, który zwraca odpowiednią odpowiedź.

Testowanie żądania posta w Pythonie

Można również przetestować pocztowy końcowy API przy użyciu Pythona requests.post . Podobnie jak podczas korzystania z funkcji pobierania JavaScript , musisz również tutaj określić ładunek:

import requests payload = { 'title': 'new product', 'price': 13.5, 'description': 'test description', 'image': '', 'category': 'electronic' } Posted = requests.post('https://fakestoreapi.com/products', data = payload ) print(Posted.status_code) print(Posted.json())

Podobnie jak JavaScript, powyższy kod Pythona rejestruje również kod statusu odpowiedzi i nowe dane określone w ładunku .

Testowanie punktów końcowych Put

Aktualizowanie danych interfejsu API przebiega tak samo, jak publikowanie i pobieranie ich w obu językach.

Aby to zrobić za pomocą funkcji pobierania JavaScript , wystarczy zastąpić Post przez Put :

// Specify the payload let payload = { title: 'new product', price: 13.5, description: 'test description', image: '', category: 'electronic' } fetch('https://fakestoreapi.com/products/19', { method: "Put", headers:{ 'Content-Type': 'application/json' }, body: JSON.stringify(payload) //convert the payload into JSON } ).then(res =>{ if (res.ok){ console.log(res.status) return res.json() } }).then(response => { console.log(response) }).catch(err => console.log(err))

Jeśli zwrócisz uwagę na punkt końcowy interfejsu API, zobaczysz, że tym razem zawiera on identyfikator produktu. W ten sposób API wie, jakie dane chcesz zaktualizować w tym przypadku.

Niemniej jednak niektóre interfejsy API mogą używać innych metod do tworzenia swoich punktów końcowych. Więc to nie jest standard.

Aby przetestować aktualizację danych przy użyciu API Pythona, należy użyć requests.put zamiast:

import requests payload = { 'title': 'new product', 'price': 13.5, 'description': 'test description', 'image': '', 'category': 'electronic' } Posted = requests.put('https://fakestoreapi.com/products/19', data = payload ) print(Posted.status_code) print(Posted.json())

Powyższe przykłady, jeśli się powiedzie, wstaw nowe dane do pozycji 19, jak wskazuje punkt końcowy interfejsu API.

Testowanie żądania usunięcia

Usuwanie danych z interfejsu API jest tak proste, jak wysłanie żądania Get. Dzieje się tak, ponieważ w przeciwieństwie do Post and Put nie musisz określać żadnego ładunku. Wszystko, czego potrzebujesz, to punkt końcowy usuwania.

Nasz wybrany interfejs API używa identyfikatora produktu do śledzenia jego danych. Tak więc usunięcie produktu jest łatwe:

fetch('https://fakestoreapi.com/products/19', { method: "Delete", headers:{ 'Content-Type': 'application/json' } } ).then(res =>{ if (res.ok){ console.log(res.status) return res.json() } }).then(response => { console.log(response) }).catch(err => console.log(err))

Potrzebujesz tylko kilku linijek kodu, aby osiągnąć to samo za pomocą Pythona:

import requests Posted = requests.delete('https://fakestoreapi.com/products/19', ) print(Posted.status_code) print(Posted.json())

Oba powyższe przykłady rejestrują kod statusu odpowiedzi i dane należące do identyfikatora, którego dotyczy zapytanie (w tym przypadku 19).

Czy te metody testowania są ogólne?

Chociaż w tym poście skupiliśmy się tylko na jednym interfejsie API, metody używane do testowania punktów końcowych CRUD nie różnią się w przypadku innych interfejsów API. Jedyną różnicą mogą oczywiście być zasady otaczające każdą strukturę API i wytyczne dotyczące żądania danych. Po odszyfrowaniu ich dla wybranego interfejsu API, możesz użyć odpowiedniej metody, jak opisano tutaj, aby przetestować odpowiadające mu punkty końcowe.

Tak więc, ponieważ każdy interfejs API ma reguły łączenia się z nim, więc podczas testowania niektóre mogą dostarczyć dodatkowe parametry, które należy uwzględnić w nagłówkach żądań. Takie parametry zwykle zawierają token dostępu lub inne, jak podano w dokumentacji.