apistar
1.0.0
- ชุดเครื่องมือ Web API -
ชุมชน: https://discuss.apistar.org ? - - -
เอกสารประกอบ: https://docs.apistar.com
ข้อกำหนด: Python 3.6+
API Star เป็นชุดเครื่องมือสำหรับการทำงานกับ OpenAPI หรือ Swagger schema ช่วยให้คุณ:
คุณสามารถใช้เพื่อสร้างเอกสารแบบคงที่ บูรณาการภายในกรอบงานเว็บ หรือใช้เป็นไลบรารีไคลเอ็นต์สำหรับการโต้ตอบกับ API อื่นๆ
ติดตั้ง API ดาว:
$ pip3 install apistarมาดูฟังก์ชันการทำงานบางอย่างที่ชุดเครื่องมือมีให้...
เราจะเริ่มต้นด้วยการสร้างสคีมา OpenAPI schema.yaml :
openapi : 3.0.0
info :
title : Widget API
version : ' 1.0 '
description : An example API for widgets
servers :
- url : https://www.example.org/
paths :
/widgets :
get :
summary : List all the widgets.
operationId : listWidgets
parameters :
- in : query
name : search
description : Filter widgets by this search term.
schema :
type : string มาสร้างไฟล์กำหนดค่า apistar.yml ด้วย:
schema :
path : schema.yaml
format : openapi ตอนนี้เราพร้อมที่จะเริ่มใช้เครื่องมือบรรทัดคำสั่ง apistar แล้ว
เราสามารถตรวจสอบสคีมา OpenAPI ของเราได้:
$ apistar validate
✓ Valid OpenAPI schema.
หรือสร้างเอกสารสำหรับนักพัฒนาสำหรับ API ของเรา:
$ apistar docs --serve
✓ Documentation available at "http://127.0.0.1:8000/" (Ctrl+C to quit)
นอกจากนี้เรายังสามารถสร้างคำขอ API ไปยังเซิร์ฟเวอร์ที่อ้างอิงในสคีมา:
$ apistar request listWidgets search=cogwheel
ตั้งแต่เวอร์ชัน 0.6 เป็นต้นไป โปรเจ็กต์ API Star กำลังมุ่งเน้นไปที่ชุดเครื่องมือ API ที่ไม่เชื่อเรื่องกรอบงาน แผนคือการสร้างฟังก์ชันการทำงานนี้ในลักษณะที่ทำให้เหมาะสมสำหรับการใช้งานทั้งในฐานะเครื่องมือแบบสแตนด์อโลนหรือร่วมกับเฟรมเวิร์กที่หลากหลาย
สาขา 0.5 ยังคงมีอยู่บน GitHub และสามารถติดตั้งได้จาก PyPI ด้วย pip install apistar==0.5.41 การพัฒนาเพิ่มเติมใด ๆ ของเซิร์ฟเวอร์ API Star อาจจะต้องต่อต้านทางแยกดังกล่าวภายใต้ผู้ดูแลคนใหม่
หากคุณกำลังมองหาเฟรมเวิร์กอะซิงก์ที่ใช้ Python ประสิทธิภาพสูง ฉันจะแนะนำ Starlette แทน
API Star เป็นรหัสลิขสิทธิ์ BSD
ออกแบบและสร้างขึ้นในเมืองไบรตัน ประเทศอังกฤษ
