SCAIFE API

scaife-api

การกระจายไฟล์นิยาม SCAIFE API นี้รวมถึงไฟล์ Yaml, JSON และ HTML ในรุ่นส่วนใหญ่มีไฟล์หนึ่งไฟล์ในแต่ละรูปแบบไฟล์สำหรับแต่ละโมดูล SCAIFE ห้าโมดูล

ในเดือนมีนาคม 2564 SCAIFE APIS เราเปิดตัวไฟล์ YAML เท่านั้น รุ่นนี้มีโมดูลทั้งหมดของเราอัปเดตเพื่อใช้รูปแบบ OpenAPI เวอร์ชัน 3 ในอนาคตเราจะอัปเดตสคริปต์ของเราที่สร้างการสร้างรหัสอัตโนมัติเป็น JSON และ HTML เพื่อทำงานกับ OpenAPI เวอร์ชัน 3

ไฟล์ YAML ระบุการวิเคราะห์ซอร์สโค้ดการวิเคราะห์สภาพแวดล้อมเฟรมเวิร์กเฟรมเวิร์ก (SCAIFE) คำจำกัดความ API [1, 2, 3, 5] ในรูปแบบที่นักพัฒนาสามารถใช้เพื่อดูแก้ไขและสร้างรหัสโดยอัตโนมัติ ไฟล์ YAML ถูกสร้างขึ้นเกือบทั้งหมดโดยนักพัฒนา SEI สิ่งเดียวที่สร้างขึ้นโดยอัตโนมัติโดยเครื่องมือ Swagger ภายในไฟล์ YAML เป็นตัวอย่างบางส่วน

ไฟล์ JSON ถูกสร้างขึ้นอัตโนมัติโดยใช้ Swagger-Codegen บนไฟล์ Swagger.yaml เนื่องจากนักพัฒนาบางคนต้องการดู API ใน JSON หรือมีเครื่องมือสร้างรหัสที่ทำงานได้ดีที่สุดกับ JSON

ไฟล์ HTML ยังระบุคำจำกัดความ SCAIFE API ในรูปแบบที่อ่านได้โดยผู้ที่ไม่ต้องการ (หรือไม่มีเครื่องมือในการอ่านไฟล์ YAML ไฟล์ HTML สามารถดูได้ในเว็บเบราว์เซอร์มาตรฐานใด ๆ ไฟล์ HTML มีการเชื่อมโยงหลายมิติและกระดาษสีขาวอ้างอิงด้านล่างให้คำแนะนำเกี่ยวกับวิธีการทำความเข้าใจไฟล์ HTML

SCAIFE เป็นสถาปัตยกรรมที่สนับสนุนการจำแนกการแจ้งเตือนการวิเคราะห์แบบคงที่และการจัดลำดับความสำคัญ ได้รับการออกแบบมาเพื่อให้เครื่องมือวิเคราะห์แบบคงที่หลากหลายสามารถรวมเข้ากับระบบโดยใช้คำจำกัดความ API ที่เรากำลังพัฒนา ในฐานะรุ่น SCAIFE API 2.0.0 เราได้เพิ่มการโทร API เพื่อเปิดใช้งาน SCAIFE เพื่อรับการอัปเดตเกี่ยวกับการดำเนินการรหัสและผลลัพธ์การวิเคราะห์แบบคงที่ใหม่จากเซิร์ฟเวอร์การรวม (CI) อย่างต่อเนื่อง เราคาดหวังว่า API จะเป็นที่สนใจขององค์กรที่พัฒนาและ/หรือการวิจัยเครื่องมือวิเคราะห์แบบคงที่การวิเคราะห์แบบคงที่การแจ้งเตือนผู้รวบรวมการตรวจสอบบัญชีและการวิเคราะห์แบบคงที่การแจ้งเตือนการตรวจสอบการตรวจสอบอื่น ๆ คำจำกัดความของ SCAIFE API นี้สามารถอ้างอิงได้โดยนักพัฒนาเพื่อช่วยให้พวกเขาประเมินความพยายามในการพัฒนาที่จะต้องปรับเปลี่ยนเครื่องมือขององค์กรเพื่อทำการและตอบสนองต่อการโทร SCAIFE API นอกจากนี้คำจำกัดความของ API นี้กำลังได้รับการเผยแพร่โดยมีเป้าหมายในการสร้างข้อเสนอแนะจากนักพัฒนาและองค์กรที่สนใจในการใช้ SCAIFE API เพื่อช่วยปรับปรุง SCAIFE API ให้นักพัฒนาสามารถใช้งานได้ง่ายขึ้นสำหรับเครื่องมือวิเคราะห์แบบคงที่ที่หลากหลาย ระบบต้นแบบที่ใช้มันได้รับการแจกจ่ายให้กับผู้ทำงานร่วมกันของโครงการวิจัย

scaife

สถาปัตยกรรม SCAIFE ที่แสดงในรูปประกอบด้วยเซิร์ฟเวอร์ห้าเซิร์ฟเวอร์ ระบบเป็นโมดูลออกแบบเพื่อให้แต่ละโมดูลสามารถสร้างอินสแตนซ์ด้วยเครื่องมือ/ซอฟต์แวร์ที่แตกต่างกันในขณะที่ระบบโดยรวมควรรักษาฟังก์ชันการทำงานเดียวกัน โมดูล UI มี Front-end GUI ที่เปิดใช้งานการแจ้งเตือนการวิเคราะห์การค้นหาแบบคงที่ (FFSA) และจัดเก็บโครงการท้องถิ่น สถาปัตยกรรม SCAIFE มีวัตถุประสงค์เพื่อเปิดใช้งานเครื่องมือ FFSA ที่หลากหลายและเครื่องมือ Aggregator Aggregator เพื่อรับการจำแนกประเภทและการจัดลำดับความสำคัญโดยการโต้ตอบเป็นโมดูล UI กับระบบ SCAIFE ที่เหลือ เครื่องมือเหล่านี้จะต้องยกตัวอย่างโมดูล UI API ไปยังเซิร์ฟเวอร์อื่นเพื่อทำเช่นนั้น โมดูล DataHub เก็บข้อมูล (เครื่องมือการแจ้งเตือนโครงการชุดทดสอบเมตาดาต้า adjudicatons ฯลฯ ) จากโมดูล UI หนึ่งโมดูลหรือมากกว่าหนึ่งโมดูล โมดูลสถิติสร้างวิ่งและเก็บตัวแยกประเภทและอัลกอริทึมการวิเคราะห์ฮิวริสติก (การเรียนรู้ที่ใช้งาน) และอัลกอริทึมพารามิเตอร์ไฮเปอร์พารามิเตอร์อัตโนมัติ โมดูลจัดลำดับความสำคัญจัดเก็บสูตรการจัดลำดับความสำคัญและฟิลด์การจัดลำดับความสำคัญของผู้ใช้ โมดูลการลงทะเบียนใช้สำหรับการตรวจสอบสิทธิ์และการควบคุมการเข้าถึง มันสร้างโทเค็นการลงทะเบียนรวมทั้งให้การรับรองความถูกต้องและการอนุญาตพื้นฐานสำหรับเซิร์ฟเวอร์อื่น ๆ

วิธีเริ่มต้นใช้งาน API

เลือกหนึ่งในห้าโมดูลเพื่อเริ่มการตรวจสอบ: เครื่องมือ FFSA และเครื่องมือ Aggregator Aggregator ส่วนใหญ่จะสนใจมากที่สุดในคำจำกัดความ API ของโมดูล UI ในการเปิดใช้งานเครื่องมือของพวกเขาในการโต้ตอบกับระบบ SCAIFE เครื่องมือของพวกเขาจำเป็นต้องยกตัวอย่าง API ของโมดูล UI อย่างไรก็ตามนักวิจัย/นักพัฒนาบางคนมุ่งเน้นไปที่การปรับปรุงการจำแนกประเภทการเรียนรู้ที่ใช้งานและการเพิ่มประสิทธิภาพพารามิเตอร์ไฮเปอร์พารามิเตอร์อัตโนมัติจะต้องการมุ่งเน้นไปที่ API ของโมดูลสถิติแทน พวกเขาสามารถพัฒนาอัลกอริทึมใหม่และรวมเข้าด้วยกันภายในต้นแบบที่เราพัฒนาขึ้น (หากพวกเขาเป็นผู้ทำงานร่วมกันวิจัยของเรา) หรือเพียงแค่ปรับเปลี่ยนเครื่องมือของตัวเองเพื่อยกตัวอย่าง API ของโมดูลสถิติและจากนั้นโต้ตอบกับระบบ SCAIFE กับโมดูลอื่น ๆ ที่พัฒนาโดยคนที่แตกต่างกัน ในทำนองเดียวกันนักวิจัย/นักพัฒนาบางคนให้ความสำคัญกับการปรับปรุงประสิทธิภาพความปลอดภัยความยืดหยุ่นและความยืดหยุ่นของการจัดเก็บข้อมูลที่รวมและในที่สุด คนเหล่านั้นจะต้องการมุ่งเน้นไปที่ API ของโมดูล Datahub เราคาดว่านักวิจัย/นักพัฒนาจำนวนน้อยจะใช้โมดูลการลงทะเบียนหรือจัดลำดับความสำคัญ อย่างไรก็ตาม API ของพวกเขาจะยังคงมีประโยชน์ในการตรวจสอบเนื่องจากเซิร์ฟเวอร์อื่น ๆ จำเป็นต้องโต้ตอบกับพวกเขาไม่ว่าจะเป็นในไคลเอนต์หรือบทบาทเซิร์ฟเวอร์

หากเป็นไปได้เราขอแนะนำให้คุณใช้โปรแกรมแก้ไขแบบโอเพนซอร์ซ (และฟรี) Swagger [4] หรือเครื่องมือดูและแก้ไข API ที่คล้ายกัน เปิดไฟล์นิยาม API (.yaml หรือ. json) ในนั้น Swagger Editor เป็นวิธีที่ใช้งานง่ายในการดูทำการทดสอบอย่างง่ายและปรับเปลี่ยนคำจำกัดความ API

มิฉะนั้นให้ดูไฟล์นิยาม HTML API ในเว็บเบราว์เซอร์ ด้วยวิธีนี้โมเดลและวิธีการสามารถเข้าถึงได้โดยทำตามไฮเปอร์ลิงก์ที่เกี่ยวข้องกับแต่ละทรัพยากรในส่วนคำจำกัดความ SCAIFE API ด้านล่าง

แต่ละส่วนคำจำกัดความ API ถูกจัดหมวดหมู่ตามโมดูลต้นทางและปลายทางของการเรียก API ตัวอย่างเช่นส่วนคำจำกัดความการลงทะเบียนของโมเดลและโมดูลล็อกอิน API มีเพียงหมวดหมู่เดียวของการโทร API ภายใต้ฉลาก UITOREGISTRATION แหล่งที่มา (คำขอ) ของการโทร API มาจากโมดูล UI และการโทร API จะถูกส่งต่อไปยังปลายทาง - โมดูลการลงทะเบียน แบบจำลองข้อมูลถูกกำหนดไว้ในส่วนล่างของไฟล์

หวังว่าคุณจะไม่ตรวจสอบ API เท่านั้นคุณจะใช้มันเพื่อรวมเครื่องมือหรือรหัสของคุณเข้ากับระบบ SCAIFE คุณสามารถสร้างรหัสโดยอัตโนมัติจากคำจำกัดความ YAML หรือ JSON API ของโมดูล SCAIFE ใด ๆ โดยใช้ Swagger Codegen [4] หรือเครื่องมือที่คล้ายกัน สิ่งนี้ไม่เพียง แต่มีประโยชน์ในการเร่งและพัฒนารหัสโดยอัตโนมัติ แต่ยังช่วยให้มั่นใจได้ว่ารหัสอินสแตนซ์ SCAIFE API หากคุณมีเครื่องมือที่คุณต้องการสร้างรหัสไคลเอนต์สำหรับ (หมายถึงคุณต้องการรหัสที่จะโทรไปยังเซิร์ฟเวอร์ SCAIFE ที่กำหนดไว้ในคำจำกัดความ API ของเซิร์ฟเวอร์นั้น) เครื่องมือเช่น Swagger Codegen จะสร้างรหัสในภาษาที่หลากหลาย คุณสามารถ plop รหัสไคลเอนต์ที่สร้างขึ้นในรหัสของคุณเองในสถานที่ที่เหมาะสมและใช้ตัวแปรของคุณเองเป็นพารามิเตอร์ ในทำนองเดียวกันคุณสามารถสร้างรหัสเซิร์ฟเวอร์โดยอัตโนมัติสำหรับโมดูล SCAIFE ใด ๆ รวมถึงสตับฟังก์ชั่นคอนโทรลเลอร์สำหรับการเรียก API แต่ละรายการไปยังเซิร์ฟเวอร์นั้นซึ่งคุณจะได้รับรหัสภายในสำหรับ

หมายเหตุพิเศษสำหรับผู้ตรวจสอบ API:

• ขอบคุณที่ส่งความคิดเห็น API ของคุณเกี่ยวกับสิ่งที่มีประโยชน์และสิ่งที่สามารถแก้ไขได้เพื่อให้ SCAIFE API มีประโยชน์มากขึ้นสำหรับคุณ ความคิดเห็นรีวิวของคุณจะช่วยให้เราปรับปรุง SCAIFE API เวอร์ชันในอนาคต
• ในฐานะที่เป็น SCAIFE API รุ่น 2.0.0 เราได้อัพเกรดเป็น OpenAPI เวอร์ชัน 3 (ก่อนหน้านี้เราใช้ Swagger เวอร์ชัน 2 ข้อ จำกัด บางอย่างของ Swagger เวอร์ชัน 2 มีผลกระทบต่อ API ที่เกิดขึ้นตัวอย่างเช่น Swagger เวอร์ชัน 2 ไม่เปิดใช้งานไฟล์ API
• โทเค็นการเข้าถึงใช้ใน SCAIFE API และมีรายละเอียดที่นี่

ข้อมูลที่เกี่ยวข้อง

1. Lori Flynn และ Ebonie McNeil "SCAIFE API คำจำกัดความเบต้าเวอร์ชัน 0.0.2 สำหรับนักพัฒนา", whitepaper, สถาบันวิศวกรรมซอฟต์แวร์, 14 มิถุนายน 2019. https://resources.sei.cmu.edu/library/asset-view.cfm?assetid=549351
2. Lori Flynn และ Ebonie McNeil "การรวมการจำแนกการวิเคราะห์การวิเคราะห์แบบสแตติกอัตโนมัติและการจัดลำดับความสำคัญกับเครื่องมือตรวจสอบ: มุ่งเน้นพิเศษเกี่ยวกับขนาด", รายงานทางเทคนิค, สถาบันวิศวกรรมซอฟต์แวร์, 13 พฤษภาคม 2019. https://resources.sei.cmu.edu/library/asset-view.cfm
3. "การใช้ระบบอัตโนมัติเพื่อจัดลำดับความสำคัญการแจ้งเตือนจากเครื่องมือการวิเคราะห์แบบคงที่", หน้าเว็บสถาบันวิศวกรรมซอฟต์แวร์ในหัวข้อการวิจัยสร้างขึ้นในเดือนกันยายน 2017 https://www.sei.cmu.edu/research-capabilities/all-work/display.cfm?customel_datapageid_4050
4. Swagger ตรึงที่เก็บ เว็บไซต์ GitHub https://github.com/swagger-api
5. Lori Flynn และ Ebonie McNeil "การสร้างระบบจัดการการแจ้งเตือนอัตโนมัติที่แม่นยำ (2019)", การนำเสนอ, ตุลาคม 2019. https://resources.sei.cmu.edu/library/asset-view.cfm?assetid=635433