httpYac คืออะไร

หากคุณเคยค้นหา httpYac คุณอาจกำลังมองหาวิธีส่งคำขอ HTTP จากไฟล์ข้อความธรรมดาที่คุณสามารถเก็บไว้ใน Git เรียกใช้ใน VS Code และเล่นซ้ำใน CI httpYac คือสิ่งนั้นเอง: เครื่องมือเรียกใช้ไฟล์ .http/.rest ที่มาพร้อมกันทั้งส่วนขยาย VS Code และเครื่องมือบรรทัดคำสั่ง Node.js คู่มือนี้จะอธิบายวิธีการทำงาน แสดงตัวอย่างเล็กๆ น้อยๆ ครอบคลุมถึงเวลาที่เหมาะสม และชี้แนวทางสำหรับ GUI และ CI เมื่อคุณเริ่มใช้ไฟล์ข้อความไม่เพียงพอ สำหรับความรู้พื้นฐานที่กว้างขึ้นในสาขาวิชานี้ โปรดดู คู่มือการทดสอบ API ของเรา

httpYac คืออะไรกันแน่

httpYac เป็นไคลเอนต์ HTTP แบบโอเพนซอร์สที่สร้างขึ้นรอบรูปแบบไฟล์ .http คุณเขียนคำขอเป็นข้อความธรรมดา จากนั้นส่งด้วยการกดปุ่มในโปรแกรมแก้ไข หรือด้วยคำสั่งเดียวในเทอร์มินัลของคุณ โปรเจกต์นี้อยู่บน GitHub และมีเอกสารประกอบฉบับเต็มที่ httpyac.github.io

แนวคิดหลักนั้นง่ายมาก คำขอจะอยู่ในไฟล์ข้อความถัดจากโค้ดของคุณ คุณจัดการเวอร์ชันด้วย Git คุณตรวจสอบใน pull request คุณเรียกใช้ด้วยวิธีเดียวกันไม่ว่าคุณจะเป็นคนในโปรแกรมแก้ไข หรือเป็นงาน CI บนเซิร์ฟเวอร์บิลด์ โมเดลที่ใช้ Git เป็นหลักและเป็นข้อความธรรมดานี้คือจุดแข็งที่ใหญ่ที่สุดของ httpYac และเป็นเหตุผลที่นักพัฒนาแบ็กเอนด์จำนวนมากเลือกใช้มัน

เครื่องมือนี้ประกอบด้วยสองส่วน:

• ส่วนขยาย VS Code (httpYac) ให้คุณมี "Send Request" code lens เหนือแต่ละคำขอ, การแสดงตัวอย่างการตอบกลับ และการสลับสภาพแวดล้อมภายในโปรแกรมแก้ไข
• CLI (httpyac, ติดตั้งผ่าน npm) เรียกใช้ไฟล์เดียวกันแบบไร้ส่วนหัว นั่นคือสิ่งที่ทำให้มันเป็นมิตรกับ CI: ไฟล์ที่คุณทดสอบในเครื่องคือไฟล์ที่ pipeline ของคุณเรียกใช้

เนื่องจากทั้งสองส่วนอ่านไฟล์ .http เดียวกัน จึงไม่มีขั้นตอนการส่งออกแยกต่างหาก สิ่งที่คุณคอมมิตคือสิ่งที่ทำงาน

รูปแบบไฟล์ .http

ไฟล์ .http คือรายการคำขอที่คั่นด้วย ### แต่ละคำขออ่านเกือบจะเหมือน HTTP ดิบที่ส่งไป นี่คือตัวอย่างเล็กๆ น้อยๆ

### Get a user
GET https://api.example.com/users/42
Accept: application/json

### Create a user
# @name createUser
POST https://api.example.com/users
Content-Type: application/json

{
  "name": "Ada Lovelace",
  "email": "ada@example.com"
}

### Use a value from the previous response
GET https://api.example.com/users/{{createUser.response.body.$.id}}
Authorization: Bearer {{token}}

มีบางอย่างเกิดขึ้นที่นี่ บรรทัด ### ใช้แบ่งคำขอ ส่วนความคิดเห็น # @name จะตั้งชื่อคำขอเพื่อให้คุณสามารถอ้างอิงการตอบกลับได้ในภายหลัง ตัวยึด {{...}} ใช้ดึงตัวแปร รวมถึงค่าที่เชื่อมโยงจากการตอบกลับก่อนหน้า รูปแบบนี้ใช้ร่วมกันกับส่วนขยาย REST Client ยอดนิยม ดังนั้นไฟล์จึงมักจะย้ายไปมาระหว่างสองส่วนนี้ได้ด้วยการแก้ไขเพียงเล็กน้อย

ตัวแปรและสภาพแวดล้อม

httpYac อ่านตัวแปรจากไฟล์ .env, จากไฟล์ http-client.env.json และจากการกำหนดค่าแบบอินไลน์ภายในไฟล์คำขอเอง คุณสามารถเก็บชุดค่าหนึ่งไว้สำหรับ local, อีกชุดสำหรับ staging และอีกชุดสำหรับ production จากนั้นสลับไปมาระหว่างกันได้โดยไม่ต้องแก้ไขคำขอ

@host = https://api.staging.example.com

### Login
# @name login
POST {{host}}/auth/login
Content-Type: application/json

{ "user": "{{USERNAME}}", "pass": "{{PASSWORD}}" }

ข้อมูลลับจะอยู่ในไฟล์ .env ที่คุณเก็บไว้นอก Git ดังนั้นไฟล์คำขอจึงปลอดภัยที่จะคอมมิต ใน CI ตัวแปรเดียวกันนี้จะมาจากตัวแปรสภาพแวดล้อมหรือข้อมูลลับของ pipeline

การเขียนสคริปต์และการยืนยัน

นี่คือจุดที่ httpYac ก้าวข้ามเครื่องมือส่งคำขอพื้นฐาน คุณสามารถฝัง JavaScript ในคำขอเพื่อตั้งค่าข้อมูลก่อนที่จะรัน หรือเพื่อตรวจสอบการตอบกลับหลังจากนั้น บล็อกก่อนและหลังการร้องขอ (pre-request and post-request) จะทำงานในบริบทของ Node คุณจึงสามารถคำนวณลายเซ็น จัดเก็บโทเค็น หรือยืนยันผลบนเนื้อหา (body) ได้

### Login and capture token
# @name login
POST {{host}}/auth/login
Content-Type: application/json

{ "user": "{{USERNAME}}", "pass": "{{PASSWORD}}" }

{{
  // post-request script
  test("status is 200", () => {
    client.assert.strictEqual(response.statusCode, 200);
  });
  exports.token = response.parsedBody.token;
}}

token ที่ถูกบันทึกไว้นั้นจะสามารถนำไปใช้ในคำขอถัดไปได้ในรูปแบบ {{token}} โมเดลการเขียนสคริปต์นี้มีความยืดหยุ่น ซึ่งเป็นส่วนหนึ่งของความน่าสนใจสำหรับนักพัฒนาที่ต้องการตรรกะโดยไม่ต้องสร้างเฟรมเวิร์กการทดสอบเต็มรูปแบบ

การรัน httpYac ใน CI

CLI คือสะพานเชื่อมจาก "ทำงานบนเครื่องของฉัน" ไปสู่ "ทำงานใน pipeline" ติดตั้งแล้วชี้ไปที่ไฟล์ของคุณ

npm install -g httpyac

# Run a single file
httpyac send api/users.http

# Run every request in a folder, pick an environment, fail on assertion errors
httpyac send --all --env staging "api/**/*.http"

httpYac จะออกด้วยค่าที่ไม่ใช่ศูนย์เมื่อการยืนยันล้มเหลว ซึ่งเป็นสิ่งที่งาน CI ต้องการเพื่อทำเครื่องหมายบิลด์เป็นสีแดง มันสามารถสร้างเอาต์พุตสไตล์ JUnit สำหรับเครื่องมือรายงานผลการทดสอบได้ ดังนั้นผลลัพธ์จะแสดงบนแดชบอร์ด CI ของคุณ แทนที่จะถูกฝังอยู่ในบันทึก วางคำสั่งนั้นลงใน GitHub Actions, GitLab CI หรือ Jenkins แล้วไฟล์เดียวกันที่คุณแก้ไขใน VS Code ก็จะช่วยควบคุมการรวมโค้ดของคุณได้แล้ว

ควรใช้ httpYac เมื่อใด

httpYac เหมาะสมกับลักษณะของทีมและขั้นตอนการทำงานเฉพาะกลุ่ม ลองใช้เมื่อส่วนใหญ่ของสิ่งเหล่านี้เป็นจริง

มันจะเหมาะสมน้อยลงเมื่อผู้ที่ไม่ใช่นักพัฒนาจำเป็นต้องเรียกใช้หรือแก้ไขคำขอ, เมื่อคุณต้องการมุมมองแบบกราฟิกของชุดคำขอขนาดใหญ่, เมื่อคุณต้องการสภาพแวดล้อมที่ใช้ร่วมกันและการซิงค์ทีมโดยไม่ต้องตั้งค่าไฟล์, หรือเมื่อคุณต้องการการรายงานที่สมบูรณ์และการทดสอบโหลดในที่เดียว ประโยชน์ของข้อความธรรมดาจะเป็นคุณสมบัติที่ดีจนกระทั่งชุดคำขอมีขนาดใหญ่ขึ้นและทีมขยายตัว

httpYac เทียบกับแพลตฟอร์ม GUI และ CI

httpYac เป็นเครื่องมือเรียกใช้ไฟล์ข้อความ ส่วน Apidog เป็นโมเดลที่แตกต่างกัน: แพลตฟอร์ม API แบบ GUI-first ที่ทำงานใน CI ได้ด้วย ไม่มีอันไหน "ดีกว่า" โดยสมบูรณ์; พวกมันแก้ปัญหาจากคนละด้าน สิ่งหนึ่งที่ต้องทำความเข้าใจล่วงหน้าคือ: Apidog ไม่ได้รันหรือแยกวิเคราะห์ไฟล์ .http โดยตรง หากแหล่งความจริงของคุณคือโฟลเดอร์ของไฟล์ .http แล้ว httpYac จะรันไฟล์เหล่านั้นโดยตรง และนั่นคือจุดแข็งที่แท้จริงของมัน

นี่คือการเปรียบเทียบทั้งสองในประเด็นที่มักจะใช้ในการตัดสินใจเลือก

หากคุณต้องการด้านที่เป็นภาพ Apidog ช่วยให้คุณสร้างและจัดระเบียบคำขอได้โดยไม่ต้องเขียนไฟล์ด้วยมือ จากนั้นจึงรันสถานการณ์เดียวกันใน CI ด้วย apidog run เอกสารอ้างอิง apidog run จะอธิบายคำสั่ง, แฟล็กสภาพแวดล้อม และเครื่องมือรายงานผลการทดสอบ นอกจากนี้ คุณยังจะได้รับเซิร์ฟเวอร์จำลองและเอกสารประกอบใน workspace เดียวกัน ซึ่งเป็นสิ่งที่เครื่องมือรันไฟล์ข้อความต้องอาศัยเครื่องมืออื่นๆ หากการจำลองเป็นสิ่งจำเป็นจริงๆ บทความรวม เครื่องมือจำลองปลายทาง REST ของเราครอบคลุมทางเลือกต่างๆ

สรุปอย่างตรงไปตรงมา: httpYac เหมาะสมที่สุดเมื่อขั้นตอนการทำงานทั้งหมดของคุณคือ “ไฟล์ใน Git, รันในโปรแกรมแก้ไข, เล่นซ้ำใน CI” และทีมของคุณเป็นนักพัฒนาทั้งหมด Apidog เหมาะสมที่สุดเมื่อคุณต้องการ workspace แบบภาพที่ใช้ร่วมกัน, สภาพแวดล้อมที่มีการจัดการ, การจำลอง และเอกสารประกอบควบคู่ไปกับการรัน CI บางทีมถึงกับใช้ทั้งสองอย่าง โดยใช้ httpYac สำหรับการตรวจสอบในเครื่องอย่างรวดเร็ว และใช้ Apidog เป็นแหล่งข้อมูลความจริงของทีม เลือกโมเดลที่ตรงกับวิธีการทำงานของทีมคุณ

คำถามที่พบบ่อย

httpYac ฟรีหรือไม่

ใช่ httpYac เป็นโอเพนซอร์สภายใต้สัญญาอนุญาต MIT ทั้งส่วนขยาย VS Code และ CLI สามารถติดตั้งและใช้งานได้ฟรี ไม่ต้องมีระดับบริการแบบเสียเงินหรือข้อกำหนดบัญชีใดๆ เพื่อรันคำขอทั้งในเครื่องหรือใน CI

httpYac แตกต่างจากส่วนขยาย REST Client อย่างไร

ทั้งคู่ใช้รูปแบบไฟล์ .http เดียวกัน ดังนั้นไฟล์จึงสามารถพกพาได้เป็นส่วนใหญ่ httpYac เพิ่ม CLI แบบสแตนด์อโลนสำหรับการรันแบบไร้ส่วนหัวและ CI, การจัดการสภาพแวดล้อมที่กว้างขึ้น และโมเดลการเขียนสคริปต์และการยืนยันที่สมบูรณ์ยิ่งขึ้น REST Client เป็นแบบเฉพาะในโปรแกรมแก้ไข หากคุณส่งคำขอภายใน VS Code เท่านั้น ก็สามารถใช้งานได้ทั้งคู่; แต่ถ้าคุณต้องการรันไฟล์เดียวกันใน pipeline, CLI ของ httpYac คือตัวสร้างความแตกต่าง สำหรับมุมมองที่กว้างขึ้นของเครื่องมือแก้ไข โปรดดูรายการ ปลั๊กอิน VS Code สำหรับการทดสอบ API ของเรา

httpYac สามารถแทนที่ Postman ได้หรือไม่

สำหรับนักพัฒนาที่ต้องการคำขอแบบข้อความธรรมดาใน Git และการรันใน CI นั้น httpYac ครอบคลุมหลายส่วนที่ผู้คนใช้ Postman โดยไม่มี GUI, คอลเลกชันที่ใช้ร่วมกัน และการจำลองในตัว หากทีมของคุณต้องการพื้นที่ทำงานแบบภาพ, สภาพแวดล้อมที่มีการจัดการ และการจำลองร่วมกัน แพลตฟอร์มอย่าง Apidog จะมีความเหมาะสมมากกว่า เปรียบเทียบตัวเลือกต่างๆ ในรายการ ไคลเอนต์ทดสอบ API ยอดนิยม ของเรา

httpYac รองรับ GraphQL และ gRPC หรือไม่

httpYac จัดการคำขอ GraphQL และโปรโตคอลอื่นๆ นอกเหนือจาก REST ทั่วไป รวมถึงกรณีการสตรีมมิ่งบางอย่าง ตรวจสอบเอกสารอย่างเป็นทางการสำหรับรายการโปรโตคอลปัจจุบัน เนื่องจากความสามารถในการรองรับมีการพัฒนาไปเรื่อยๆ ระหว่างการออกรุ่นใหม่ สำหรับ REST รูปแบบ .http ครอบคลุม verb, header, body และ flow การยืนยันตัวตนทั่วไปได้ทันที

บทสรุป

httpYac เป็นคำตอบที่ชัดเจนสำหรับความต้องการที่ชัดเจน: การส่งคำขอ HTTP จากไฟล์ข้อความธรรมดา, รันใน VS Code และเล่นซ้ำใน CI โดยไม่มีขั้นตอนการส่งออกแยกต่างหาก โมเดลที่ใช้ Git เป็นหลัก, การเขียนสคริปต์ และ CLI ฟรี ทำให้เป็นตัวเลือกที่แข็งแกร่งสำหรับทีมที่มีนักพัฒนาจำนวนมากที่ต้องการให้คำขอของพวกเขาอยู่ใน repo ข้อแลกเปลี่ยนคือทุกอย่างสันนิษฐานว่าต้องมีความเข้าใจเรื่องโค้ด, ไฟล์ และความคล่องแคล่วของนักพัฒนา

หากคุณต้องการสร้างคำขอด้วยภาพ, แชร์สภาพแวดล้อมที่มีการจัดการ, จำลองปลายทาง และสร้างเอกสารประกอบในขณะที่ยังคงรันการทดสอบใน CI Apidog ครอบคลุมสิ่งเหล่านั้นได้ใน workspace เดียว คุณสามารถ ดาวน์โหลด Apidog และรันชุดทดสอบของคุณด้วย apidog run หรือใช้ httpYac สำหรับการตรวจสอบในเครื่องอย่างรวดเร็ว และให้ Apidog เป็นแหล่งข้อมูลความจริงของทีม เลือกโมเดลที่ตรงกับวิธีการทำงานของทีมคุณ