หน้าแรก>การเขียนโปรแกรมที่เกี่ยวข้อง>ซอร์สโค้ดอื่น ๆ
ดาวน์โหลด

เปิดการค้นหาเว็บ API

พื้นหลัง

ทีม Postman Open Technologies ดูแลโปรเจ็กต์ที่เกี่ยวข้องกับการขุดและการดึงความรู้จากจักรวาล API มีความรู้มากมายอยู่ใน OpenAPI, Swagger, Postman Collections, Spectral และสิ่งประดิษฐ์ API อื่นๆ ที่มีอยู่บน GitHub แต่ยังอยู่บนเว็บแบบเปิดด้วย

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

มีแหล่งข้อมูลที่รู้จักอยู่แล้ว เช่น GitHub, SwaggerHub และ APIs.guru เพื่อค้นหาข้อกำหนดเฉพาะของ OpenAPI/Swagger แต่เราต้องการมุ่งเน้นไปที่ การแยกคำจำกัดความ API จากแหล่งที่มาที่ไม่ค่อยมีคนรู้จักและนำเสนอให้โลกได้รับรู้ ชุดข้อมูลสามารถใช้เพื่อวิเคราะห์ข้อกำหนดเพื่อรับข้อมูลเชิงลึกเกี่ยวกับแนวทางปฏิบัติบางอย่างที่พบบ่อยใน API ในภายหลัง

Open API Web Search คืออะไร

โปรเจ็กต์ Open API Web Search เป็นการนำเสนอวิธีง่ายๆ สำหรับนักพัฒนาในการค้นหาคำจำกัดความ Swagger และ OpenAPI ที่มีอยู่บนเว็บแบบเปิด ซึ่งส่วนใหญ่มาจากแหล่งที่ไม่ค่อยมีใครรู้จัก เป้าหมายสูงสุดของโครงการนี้คือการสร้างเครื่องมือค้นหาสำหรับ API ที่ผู้บริโภคและผู้ผลิต API สามารถค้นพบ API โดยใช้คำหลักที่ขจัดความซับซ้อนในการค้นหาคำเฉพาะบนเว็บ ซึ่งช่วยระบุ API ในทะเลของหน้าเว็บ เรียนรู้ว่า Open API Web Search สามารถช่วยปลดปล่อยพลังของ API แบบเปิดได้อย่างไร

เป้าหมายของโครงการนี้สามารถบรรลุได้ด้วยเหตุการณ์สำคัญดังต่อไปนี้:

  1. การรวบรวมข้อมูล : รวบรวมข้อมูลหน้าเว็บที่กำลังมองหาคำจำกัดความ API ที่ถูกต้อง —ส่วนใหญ่มาจากแหล่งที่ไม่ค่อยมีใครรู้จัก
  2. การทำดัชนี : ตรวจสอบและจัดเก็บผลลัพธ์การรวบรวมข้อมูลที่จัดทำดัชนีไว้
  3. การใช้อัลกอริธึมการค้นหา : การใช้ชุดข้อมูลขนาดใหญ่ของข้อกำหนดเฉพาะของ OpenAPI/Swagger เปิดเผย API ที่สรุปความซับซ้อนในการค้นหาเว็บเพื่อหาคำเฉพาะสำหรับการค้นหา API
  4. การจัดหาอินเทอร์เฟซ : ออกแบบ UI สำหรับผู้ใช้ API และผู้ผลิตเพื่อเริ่มการค้นหาเพื่อค้นหา API ในขั้นต้น การค้นหาสามารถทำได้โดยใช้ข้อมูลเมตา ซึ่งเป็นออบเจ็กต์ข้อมูลของเอกสาร OpenAPI
  5. การอัปเดตชุดข้อมูล : อัปเดตผลลัพธ์การรวบรวมข้อมูลเป็นประจำและจัดทำดัชนีใหม่เพื่อให้ผลการค้นหาดีขึ้น

ใช้งานเซิร์ฟเวอร์

แยกและ/หรือโคลน repo OpenAPI Web Search และเปลี่ยนไดเร็กทอรีเป็น: 

 git clone https: //github.com/<username>/openapi-web-search.git
cd openapi - web - search / src / server

ติดตั้งการพึ่งพาผ่านเส้นด้าย: 

 yarn install

เริ่มเซิร์ฟเวอร์ท้องถิ่น: 

 yarn run dev

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

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

 1. http: //localhost:1337/api/v1/run/crawler?latest=true
2. http: //localhost:1337/api/v1/process/index-files?skip=0&limit=20&sort=aes
3. http: //localhost:1337/api/v1/indexing
4. http: //localhost:1337/api/v1/search?q=<query>

คำอธิบาย:

  1. จุดสิ้นสุดแรกจะรวบรวมข้อมูลเว็บไซต์ที่รวบรวมข้อมูลทั่วไปเพื่อรับไฟล์บางไฟล์ซึ่งรวมถึงเส้นทางไปยังไฟล์ดัชนีที่ถูกแปลงเป็นจุดสิ้นสุดที่เหมาะสม
  2. ตำแหน่งข้อมูลที่สองจะเริ่มต้นกระบวนการเบื้องหลังของการดาวน์โหลดไฟล์ดัชนี ประมวลผล และจัดเก็บผลลัพธ์ซึ่งมีคำจำกัดความของ openapi ที่ได้รับการตรวจสอบแล้วใน mongodb
  3. ตำแหน่งข้อมูลที่สามเริ่มสร้างดัชนีผลลัพธ์ MongoDB ที่รวบรวมไว้ก่อนหน้านี้ลงใน Elasticsearch
  4. ตำแหน่งข้อมูลสุดท้ายถูกใช้เพื่อสร้างคำค้นหาเพื่อการเรียกค้นที่เหมาะสมที่สุด
ขยาย
ข้อมูลเพิ่มเติม
แอปที่เกี่ยวข้อง
แนะนำสำหรับคุณ
ข้อมูลที่เกี่ยวข้อง ทั้งหมด