การสนับสนุนลูกค้าเจ็ท

เจ็ทไคลเอนต์

JetClient เป็นปลั๊กอินไคลเอนต์ API ที่เรียบง่ายและทรงพลังสำหรับ JetBrains IDEs (IntelliJ IDEA, GoLand, PyCharm, PhpStorm ฯลฯ ) โดยผสมผสานคุณสมบัติที่ดีที่สุดของไคลเอ็นต์ API ที่มีอยู่เข้ากับการปรับปรุงเพิ่มเติม ทั้งหมดนี้อยู่ภายใน IDE ของคุณ คุณสมบัติที่สำคัญ ได้แก่ :

• การซิงค์ไฟล์ (Git Sync) : จัดเก็บคำขอและโฟลเดอร์ในรูปแบบที่มนุษย์สามารถอ่านได้บนระบบไฟล์ของคุณ ทำให้สามารถแชร์และทำงานร่วมกับทีมของคุณผ่าน Git ได้อย่างง่ายดาย

• กลุ่มสภาพแวดล้อม : สร้างกลุ่มสภาพแวดล้อมเพื่อเลือกสภาพแวดล้อมหลายรายการพร้อมกัน ตัวอย่างเช่น กลุ่มหนึ่งสำหรับ (dev, test, prod) และอีกกลุ่มสำหรับ (ผู้ใช้, ผู้ดูแลระบบ)

• การจัดการตัวแปรที่สะดวก : ตัวแปรถูกกำหนดในรูปแบบ JSON5 และจัดเป็นโปรแกรมแก้ไขสองตัว: ที่ใช้ร่วมกัน (ซิงค์) และท้องถิ่น (ไม่ซิงค์) ตัวแปรสามารถรวมถึงไม่เพียงแต่ประเภทดั้งเดิมเท่านั้น แต่ยังรวมไปถึงอ็อบเจ็กต์และอาร์เรย์ด้วย

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

• การผสานรวมกับซอร์สโค้ดและ OpenAPI : นำเข้า API โดยตรงจากซอร์สโค้ดของคุณ และนำทางระหว่างคำขอและโค้ดที่เกี่ยวข้องได้อย่างง่ายดาย และในทางกลับกัน

• การสนับสนุน GraphQL : ผสานรวมอย่างลงตัวกับปลั๊กอิน GraphQL ของ JetBrains สำหรับการเน้นไวยากรณ์และการเติมโค้ดให้สมบูรณ์

ชมวิดีโอปลั๊กอิน JetClient เพื่อเรียนรู้เกี่ยวกับคุณสมบัติปลั๊กอิน

สารบัญ

• โครงการ

• การซิงค์ไฟล์ (Git Sync)

• สภาพแวดล้อม

• ตัวแปร

• สคริปต์

• คุกกี้

• หนังสือมอบฉันทะ

• http/2

• นำเข้า

• ผลงาน

• ความเป็นส่วนตัว

โครงการ

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

การซิงค์ไฟล์ (Git Sync)

File Sync (Git Sync) ช่วยให้สามารถบันทึกและกู้คืนคอลเลกชันคำขอของคุณบนระบบไฟล์ในเครื่อง ช่วยให้สามารถแชร์คอลเลกชันกับทีมของคุณผ่าน Git หรือระบบควบคุมเวอร์ชัน (VCS) อื่น ๆ ได้อย่างง่ายดาย

วิธีใช้การซิงค์ไฟล์

• เปิดใช้งานการซิงค์: เปิดการซิงโครไนซ์เมื่อสร้างโปรเจ็กต์ JetClient ใหม่หรือในการตั้งค่าโปรเจ็กต์

• ตั้งค่าเส้นทางการซิงค์: ระบุเส้นทางไดเรกทอรีที่จะจัดเก็บไฟล์การซิงค์

• บันทึกหรือกู้คืน: คลิกขวาที่รูทโปรเจ็กต์หรือคำขอ/โฟลเดอร์เฉพาะ และเลือก Save All หรือ Save เพื่อบันทึก หากต้องการคืนค่าหรือดูความแตกต่าง ให้เลือกตัวเลือกที่เกี่ยวข้องจากเมนูบริบทเดียวกัน

หากต้องการยกเว้นโฟลเดอร์ใดโฟลเดอร์หนึ่งจากการซิงค์ ให้ปิดใช้งานการซิงโครไนซ์ในคุณสมบัติ การเปลี่ยนแปลงนี้จะนำไปใช้กับโฟลเดอร์ที่ซ้อนกันทั้งหมดเช่นกัน

สภาพแวดล้อม

สภาพแวดล้อม ทำให้สามารถใช้ชุดตัวแปรต่างๆ สำหรับบริบทต่างๆ ได้ สิ่งเหล่านี้จัดเป็น กลุ่มสภาพแวดล้อม และคุณสามารถเลือกสภาพแวดล้อมได้หลายรายการพร้อมกัน โดยหนึ่งรายการจากแต่ละกลุ่ม

กลุ่มสภาพแวดล้อม Default จะพร้อมใช้งานเสมอ โดยทั่วไปจะรวมถึงสภาพแวดล้อมเช่น Local , Staging และ Production คุณยังสามารถสร้างกลุ่มสภาพแวดล้อมของคุณเองได้ เช่น User , Client , Region , API Version และอื่นๆ

สภาพแวดล้อมถูกกำหนดไว้ตามโครงการและสามารถสร้างได้ในแท็บ Environments ตัวแปรสำหรับสภาพแวดล้อมเหล่านี้ได้รับการตั้งค่าในแท็บ Variables

ตัวแปร

ตัวแปรใน JetClient สามารถกำหนดได้ในระดับที่แตกต่างกัน: โปรเจ็กต์ โฟลเดอร์ และรันไทม์

• ตัวแปรรันไทม์: กำหนดในสคริปต์และใช้ได้เฉพาะในระหว่างการเรียกใช้สคริปต์เท่านั้น

• ตัวแปรโปรเจ็กต์และโฟลเดอร์: กำหนดในแท็บ Variables ของโปรเจ็กต์หรือโฟลเดอร์ โดยใช้รูปแบบ JSON5

ตัวแก้ไขตัวแปรแบ่งออกเป็นสองส่วน: Shared และ Local

• ตัวแปรที่แชร์ จะถูกบันทึกไว้ในไฟล์ซิงค์โปรเจ็กต์/โฟลเดอร์ และสามารถแชร์กับทีมของคุณได้

• ตัวแปรภายในเครื่อง ได้รับการจัดเก็บไว้อย่างปลอดภัยในระบบของคุณ และไม่รวมอยู่ในไฟล์ซิงค์

ตัวแปรโปรเจ็กต์ประกอบด้วยตัวแปรเฉพาะสภาพแวดล้อมและ globals ซึ่งสามารถเข้าถึงได้โดยไม่คำนึงถึงสภาพแวดล้อมที่เลือก มีการจัดระเบียบภายในออบเจ็กต์ JSON โดยมีสภาพแวดล้อมเป็นคุณสมบัติระดับบนสุด:

 -
  โกลบอล: {baseUrl: 'https://api.example.com'
  -
  ท้องถิ่น: {โทเค็น: 'localToken'
  -
  dev: {โทเค็น: 'devToken'
  -

ตัวแปรโฟลเดอร์สามารถมีทั้งตัวแปรทั่วไปและตัวแปรเฉพาะสภาพแวดล้อม ตัวแปรทั่วไปสามารถเข้าถึงได้โดยไม่คำนึงถึงสภาพแวดล้อมที่เลือก ในขณะที่ตัวแปรเฉพาะสภาพแวดล้อมจะพร้อมใช้งานเฉพาะเมื่อเลือกสภาพแวดล้อมที่เกี่ยวข้องเท่านั้น:

 -
  myFolderVar: 'myValue',
  dev: {myFolderVar: 'devValue'
  -

ตัวแปรใน JetClient อาจเป็นประเภทดั้งเดิม อ็อบเจ็กต์ และอาร์เรย์ และสามารถใช้ได้ในสคริปต์ คำขอ และโฟลเดอร์ หากต้องการใช้ตัวแปรในฟิลด์ใดๆ ให้ใส่เครื่องหมายปีกกาคู่: {{myVar}} คุณสามารถอ้างอิงออบเจ็กต์หรืออาร์เรย์ทั้งหมดได้ เช่น ในเนื้อความของคำขอ โดยใช้ {{myRequestBody}}

ตัวแปรยังสามารถอ้างอิงตัวแปรอื่นๆ ดังที่แสดงในตัวอย่างด้านล่าง:

 -
  อาร์เรย์: [{ myProperty: 123}
  -
  // ตัวแปรนี้แก้ไขเป็นสตริง "123"
  myVar: '{{อาร์เรย์[0].myProperty}}',
  // ตัวแปรนี้แก้ไขเป็นหมายเลข 123
  myVar2: {{อาร์เรย์[0].myProperty}}}

ลำดับความละเอียดของตัวแปร

ตัวแปรได้รับการแก้ไขตามลำดับต่อไปนี้ จากลำดับความสำคัญสูงสุดไปต่ำสุด:

1. ตัวแปรรันไทม์

2. ตัวแปรโฟลเดอร์ภายในเครื่องเฉพาะสภาพแวดล้อม

3. ตัวแปรโฟลเดอร์ที่ใช้ร่วมกันเฉพาะสภาพแวดล้อม

4. ตัวแปรโฟลเดอร์ในเครื่อง

5. ตัวแปรโฟลเดอร์ที่ใช้ร่วมกัน

6. ตัวแปรจากโฟลเดอร์หลักทั้งหมด

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

8. โลกาภิวัตน์

สคริปต์

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

 CryptoJS = need("crypto-js");hmacSHA256 = (ข้อความ) => {return CryptoJS.HmacSHA256(message, jc.environment.get('secret')).toString();}

จากนั้นคุณสามารถใช้ CryptoJS และ hmacSHA256 ในคำขอล่วงหน้าและสคริปต์ทดสอบได้

คำสั่งดำเนินการ

สคริปต์จะถูกดำเนินการตามลำดับต่อไปนี้เมื่อคุณส่งคำขอหรือเรียกใช้โฟลเดอร์ที่มีตัวรันเนอร์:

1. สคริปต์เริ่มต้น ของโปรเจ็กต์ (ดำเนินการหนึ่งครั้งต่อการรัน)

2. ร้องขอสคริปต์ล่วงหน้า ของโฟลเดอร์หลักทั้งหมด (จากรูทถึงโฟลเดอร์ปัจจุบัน)

3. สคริปต์คำขอล่วงหน้า ของคำขอ

4. ทดสอบสคริปต์ ของโฟลเดอร์หลักทั้งหมด (ตั้งแต่รูทจนถึงโฟลเดอร์ปัจจุบัน)

5. สคริปต์ทดสอบ ของการร้องขอ

ขั้นตอนที่ 2-5 จะถูกทำซ้ำสำหรับแต่ละคำขอในการทำงาน

สำหรับชุดทดสอบ สคริปต์จะดำเนินการตามลำดับนี้:

1. สคริปต์เริ่มต้น ของโครงการ

2. สคริปต์ทดสอบ ของชุดทดสอบ

สคริปต์จาก jc.runRequest , jc.runFolder หรือ jc.runTestSuite เป็นไปตามลำดับการดำเนินการเดียวกันกับคำร้องขอ โฟลเดอร์ และชุดทดสอบ

ไลบรารีการเขียนสคริปต์

ไลบรารีในตัว JetClient นั้นคล้ายกับของบุรุษไปรษณีย์ แต่แทนที่จะเรียกว่า pm จะเรียกว่า jc ตัวอย่างเช่น,

 jc.test("รหัสสถานะคือ 200", () => {jc.expect(jc.response.code).to.eql(200)})

สคริปต์ JetClient สามารถใช้ Chai Assertion Library BDD ได้ สำหรับรายละเอียดเพิ่มเติม โปรดดูเอกสารประกอบของ JetClient Library นอกจากนี้ โปรดดูประเภทไลบรารี JetClient สำหรับคำจำกัดความของประเภท

ห้องสมุดภายนอก

JetClient มีไลบรารีในตัวเช่น ajv , atob , btoa , chai , cheerio , crypto-js , csv-parse/lib/sync , lodash , moment , tv4 , uuid และ xml2js ซึ่งคุณสามารถนำเข้าโดยใช้ฟังก์ชัน require นอกจากนี้ คุณสามารถเพิ่มไลบรารีของคุณเองลงในสคริปต์ได้ ไปที่ Settings > Tools > JetClient และตั้งค่า Libraries directory หากคุณใช้ไลบรารี npm ให้ระบุไดเร็กทอรีที่มี package.json และ node_modules ของคุณ มิฉะนั้น ให้ใช้ไดเร็กทอรีที่มีไลบรารีสคริปต์ของคุณอยู่ จากนั้นคุณสามารถใช้ need เพื่อนำเข้าไลบรารีของคุณ

คุกกี้

จัดการคุกกี้โดยใช้ Cookies Manager หากต้องการเปิด ให้คลิกที่ Cookies Manager ในแถบเครื่องมือของหน้าต่างเครื่องมือ

หนังสือมอบฉันทะ

รองรับพรอกซีโดยใช้การตั้งค่าพร็อกซี IDE

HTTP/2

หากต้องการส่งคำขอโดยใช้โปรโตคอล HTTP/2 โปรดเลือกตัวเลือก HTTP/2 ใน Settings > Tools > JetClient > HTTP Version

นำเข้า

JetClient รองรับการนำเข้าคอลเลกชันจากแหล่งต่างๆ:

• โครงการเจ็ทไคลเอนท์

• ฤดูใบไม้ผลิ

• แจ๊กซ์-อาร์เอส

• ชุดติดตั้งเพิ่มเติม

• OpenAPI (ผยอง)

• ม้วนผม

• บุรุษไปรษณีย์

หากต้องการนำเข้าคำขอ cURL เพียงคัดลอกคำสั่ง cURL และวางลงในช่อง URL ของคำขอ

ผลงาน

• หากคุณต้องการปรับปรุงเอกสาร โปรดส่ง PR

• ข้อเสนอแนะในการปรับปรุงผลิตภัณฑ์ต่อไป

ความเป็นส่วนตัว

• ออฟไลน์เท่านั้น: JetClient เป็นปลั๊กอินแบบออฟไลน์เท่านั้นและไม่ได้รวบรวมข้อมูลใดๆ

• พื้นที่เก็บข้อมูลที่ปลอดภัย: ตัวแปรในเครื่อง คุกกี้ และโทเค็น OAuth2 จะถูกเก็บไว้อย่างปลอดภัยในระบบของคุณ ซึ่งรวมถึงการใช้ KeePass บน Windows, Keychain บน macOS และ libsecret บน Linux

• ไม่มี Cloud Sync: ไม่มีการซิงโครไนซ์แบ็กเอนด์หรือการซิงโครไนซ์บนคลาวด์ ข้อมูลที่ละเอียดอ่อนจะถูกเก็บไว้อย่างปลอดภัยในระบบของคุณ ข้อมูลอื่นๆ จะถูกบันทึกไว้ในไดเร็กทอรี .idea/JetClient ของโปรเจ็กต์ของคุณและในไฟล์ซิงค์ JetClient หากเปิดใช้งานการซิงโครไนซ์