Swagger és postman kapcsolat az API fejlesztés során

 Swagger és postman kapcsolat az API fejlesztés során

🚀 Postman Általános Bevezetés

A Postman egy népszerű API fejlesztési és tesztelési eszköz, amely segíti a fejlesztőket az API-k gyors és hatékony kezelésében. Használható API fejlesztésre, tesztelésre, dokumentálásra és monitorozásra.
Többféle platformon elérhető (Windows, macOS, Linux), valamint böngészőalapú verzióban is használható.

---

🎯 Fő Funkciók és Képességek

Funkció	Leírás
Kéréskezelés (Request)	API végpontok hívása GET, POST, PUT, DELETE és más HTTP metódusokkal.
Gyűjtemények (Collections)	Több kérés csoportosítása egy projektben, amely könnyen kezelhető és megosztható.
Kódolási és Kérelmi Testek	Automatikus tesztek futtatása válaszok ellenőrzésére (pl. státuszkód, válaszadat).
Változók és Környezetek	Környezeti változók használata, például fejlesztői és éles környezethez külön beállítások.
Automatizált Tesztelés	Tesztelj API-kat automatikusan szkriptek segítségével.
Dokumentáció Generálása	Automatikus API dokumentáció készítése a gyűjteményekből.
Integráció más eszközökkel	Swagger (OpenAPI), Jenkins, Newman és sok más integráció támogatása.

---

🛠️ Postman és Swagger Kapcsolata

A Swagger (OpenAPI) és a Postman együttes használata jelentősen növeli a hatékonyságot az API fejlesztési folyamat során.

🔗 Swagger-ből Postman-be Importálás

1. Swagger API Dokumentáció Létrehozása:

   • A Swagger Editorban vagy más OpenAPI eszközzel készítsd el az api.yaml fájlt.

2. Exportálás OpenAPI Formátumban:

   • A Swagger Editorban exportáld a dokumentációt api.yaml vagy api.json formátumban.

3. Postman-ben Importálás:

   • Nyisd meg a Postman-t.
   • Válaszd az Import gombot.
   • Töltsd fel a Swagger YAML vagy JSON fájlt.
   • Az importálás után a Postman automatikusan létrehozza a kérések gyűjteményét a dokumentáció alapján.

---

💡 Fejlesztési Folyamat Swagger és Postman Használatával

Lépés	Swagger (OpenAPI)	Postman
API Tervezés	API végpontok és séma leírása	Importálja a dokumentációt, hogy létrehozza a kéréseket
Dokumentáció	Automatikus dokumentáció generálás	Használja az importált kéréseket dokumentációs gyűjteményként
Kódgenerálás	Generálja a szerver vagy kliens kódot	Tesztelje a generált API-kat a Postman-ban
Tesztelés	-	Végrehajtja az interaktív tesztelést és automatizált teszteket
Hibajavítás	Javítja a YAML dokumentációt	Újraimportálja és újrateszteli
Verziókezelés	Verziószámok és változások kezelése	Gyűjtemények verziózása és megosztása

---

📝 Postman Tesztelési Példa

🧩 GET Kérés Tesztelése

1. Válassz ki egy API végpontot (pl. GET /users).

2. Futtasd a kérést a Postman-ben.

3. Írj egy egyszerű tesztet a Tests fülön:

   --- javascript
   
   pm.test("Státuszkód 200", function () {
       pm.response.to.have.status(200);
   });
   
   pm.test("JSON válasz", function () {
       pm.response.to.be.json;
   });
   

🧪 Automatizált Tesztelés (Newman)

• A Postman gyűjtemények automatizált futtatására használhatod a Newman eszközt:

  ---bash
  
  npm install -g newman
  newman run felhasznalo-kezelo.postman_collection.json
  

• A Newman lehetővé teszi, hogy a tesztjeidet CI/CD pipeline-okban is futtasd.

---

💡 Swagger UI és Postman összehasonlítás

Szempont	Swagger UI	Postman
Cél	Dokumentáció és interaktív tesztelés	API fejlesztés, automatizált és interaktív tesztelés
Formátum	OpenAPI (YAML/JSON)	Postman gyűjtemények, OpenAPI import
Interaktivitás	Magas (Swagger UI-ban)	Nagyon magas, manuális és szkript alapú tesztelés
Automatizálás	Nincs beépítve	Automatizált tesztelés és futtatás (Newman)
Integráció	SwaggerHub, OpenAPI Generator	Jenkins, GitLab, CI/CD rendszerek

---

🚀 Összegzés

1. Swagger az API-k megtervezésére, dokumentálására és generálására alkalmas.
2. Postman az API tesztelésére, monitorozására és automatizált futtatására használható.
3. Az OpenAPI specifikációk importálása Postman-be egyszerűsíti a fejlesztési folyamatot.
4. A Newman segítségével a teszteket integrálhatod a CI/CD folyamatokba.

POSTMAN alapok

🚀 Postman Felület és Funkciók - Részletes Bemutató

A Postman egy grafikus felhasználói felülettel (GUI) rendelkező eszköz, amelyet API-k fejlesztésére, tesztelésére és dokumentálására használnak. Az alábbiakban részletesen bemutatom a Postman felületét és funkcióit, majd egy teljes példán keresztül végigvezetlek a használatán.

---

🖥️ 1. Postman Felület Áttekintése

🔍 Fő Felületi Elemek

Felületi Elem	Leírás
Menü (Header)	Gyors hozzáférés beállításokhoz, importáláshoz és fiókkezeléshez.
Gyűjtemények (Collections)	API kérések csoportosítása és kezelése.
Kérések (Request)	HTTP kérések létrehozása és futtatása (GET, POST, PUT, DELETE stb.).
Válaszablak (Response)	A szerver válaszának megjelenítése.
Környezetek (Environments)	Változók kezelése különböző környezetekhez (fejlesztői, tesztelési, éles).
Konzol (Console)	Hibakeresés és válasz naplózás.

---

📝 2. API Fejlesztési Példa - CRUD API

Egy egyszerű Felhasználókezelő API használatán keresztül mutatom be a Postman funkcióit.

---

💡 Előkészületek

1. Telepítsd a Postman-t: Postman Letöltése
2. Nyisd meg a Postman alkalmazást.

Online felület link : https://web.postman.co/

---

✨ 3. Gyűjtemény Létrehozása

1. Gyűjtemények fülön kattints a + New Collection gombra.
2. Adj neki egy nevet: "Felhasználókezelő API"
3. Adj hozzá egy rövid leírást (opcionális).
4. Kattints a Create gombra.

---

📝 4. Környezetek Beállítása

1. Manage Environments (fogaskerék ikon) → Add.
2. Adj neki nevet: "Fejlesztői környezet"
3. Változó hozzáadása:
   • Név: base_url
   • Érték: http://localhost:3000
4. Save gombbal mentés.

---

🚀 5. CRUD Kérések Létrehozása

✅ GET /users - Felhasználók listázása

1. Gyűjteményen belül válaszd az Add Request lehetőséget.
2. Név: "Felhasználók lekérdezése"
3. HTTP metódus: GET
4. URL: {{base_url}}/users
5. Mentés a gyűjteménybe.
6. Send gomb megnyomása.
7. ✅ Válasz ellenőrzése: A szerver visszaadja a felhasználók listáját.

---

📝 POST /users - Új felhasználó létrehozása

1. Új kérés létrehozása: "Új felhasználó létrehozása"
2. HTTP metódus: POST
3. URL: {{base_url}}/users
4. Body fül → Raw → JSON formátum kiválasztása.
5. Tartalom:

   ---json
   
   {
     "id": "1",
     "name": "John Doe",
     "email": "john.doe@example.com"
   }
   

6. Send gomb megnyomása.
7. ✅ Válasz ellenőrzése: Státuszkód 201 (Létrehozva)

---

🔍 GET /users/{id} - Egy felhasználó lekérdezése

1. Új kérés: "Felhasználó lekérdezése ID alapján"
2. HTTP metódus: GET
3. URL: {{base_url}}/users/1
4. Send gomb megnyomása.
5. ✅ Válasz ellenőrzése: Státuszkód 200 (OK)

---

📝 PUT /users/{id} - Felhasználó módosítása

1. Új kérés: "Felhasználó módosítása"
2. HTTP metódus: PUT
3. URL: {{base_url}}/users/1
4. Body fül → Raw → JSON
5. Tartalom:

   ---json
   
   {
     "name": "John Smith",
     "email": "john.smith@example.com"
   }
   

6. Send gomb megnyomása.
7. ✅ Válasz ellenőrzése: Státuszkód 200 (OK)

---

🗑️ DELETE /users/{id} - Felhasználó törlése

1. Új kérés: "Felhasználó törlése"
2. HTTP metódus: DELETE
3. URL: {{base_url}}/users/1
4. Send gomb megnyomása.
5. ✅ Válasz ellenőrzése: Státuszkód 204 (Nincs tartalom)

---

🧪 6. Automatizált Tesztelés

🔧 Teszt szkript a POST kéréshez:

1. Menj a Tests fülre.
2. Írd be a következőt:

   ----javascript
   
   pm.test("Státuszkód 201", function () {
       pm.response.to.have.status(201);
   });
   
   pm.test("JSON válasz", function () {
       pm.response.to.be.json;
   });
   
   pm.test("Helyes név", function () {
       var jsonData = pm.response.json();
       pm.expect(jsonData.name).to.eql("John Doe");
   });
   

3. Send gomb → Teszt eredmények megjelennek az alul.

---

📊 7. Dokumentáció Generálása

1. Kattints a gyűjtemény nevére a bal oldalon.
2. Válaszd a View Documentation lehetőséget.
3. Az API dokumentáció automatikusan generálódik.
4. Exportálás: A dokumentációt letöltheted vagy publikálhatod.

---

📦 8. Gyűjtemény Exportálása

1. Kattints a gyűjtemény neve melletti három pontra.
2. Válaszd az Export lehetőséget.
3. Mentés .json formátumban.

---

🚦 9. Newman CLI - Automatikus Tesztelés

1. Telepítés:

   bash
   
   npm install -g newman
   

2. Futtatás:

   bash
   
   newman run Felhasználókezelő_API.postman_collection.json
   

3. ✅ Eredmény: Konzolos jelentés a tesztek eredményéről.

---

🗂️ 10. Összegzés

Fázis	Lépés	Postman Funkció
Gyűjtemények	Gyűjtemény létrehozása	Collections
Környezetek	Változók beállítása	Environments
Tesztelés	Kérések létrehozása és futtatása	Requests
Automatikus Teszt	Tesztszkriptek írása	Tests
Dokumentáció	Automatikus dokumentáció generálása	View Documentation
Exportálás	Gyűjtemények mentése és futtatása	Export, Newman

---

💡 Tipp: A Postman és Swagger együtt használva hatékonyan támogatja az API fejlesztést, dokumentálást és tesztelést.