คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X ข้อมูล
ทำความเข้าใจและจัดการทรัพยากรตามที่อธิบายไว้ในส่วนต่อไปนี้
เกี่ยวกับแหล่งข้อมูล
มีนโยบายหลายประเภทที่ใช้แหล่งข้อมูล ทรัพยากรคือไฟล์ที่ใช้โค้ดหรือการกำหนดค่าเพื่อให้ใช้งานโดยนโยบายเมื่อแนบอยู่กับพร็อกซี API ในบางกรณี อย่างเช่นสำหรับ JavaScript และ JavaScript และ JavaScript นโยบายจะกำหนดจุดของไฟล์แนบในพร็อกซี API ที่โค้ดบางรายการควรทำงาน นโยบาย JavaScript หรือ Java callout คือตัวชี้ไปยังทรัพยากร
ตัวอย่าง JavaScript ต่อไปนี้ตั้งค่าเส้นทางคำขอ HTTP เป็นค่าของตัวแปร proxy.basepath
request.headers["RequestPath"] = context.getVariable("proxy.basepath");
ประเภททรัพยากร
ตารางต่อไปนี้จะสรุปข้อมูลประเภทต่างๆ ของทรัพยากร
ประเภททรัพยากร | คำอธิบาย |
---|---|
JAR (java) |
คลาส Java ในไฟล์ JAR ที่อ้างอิงโดยนโยบาย Javaต้องระบุ |
JavaScript (js) |
JavaScript ที่อ้างอิงโดยนโยบาย JavaScript |
JavaScript (jsc) |
โดยคอมไพล์ JavaScript ที่อ้างอิงโดยนโยบาย JavaScript |
Hosted target (hosted) |
ไฟล์ Node.js เพื่อทำให้ใช้งานได้ในเป้าหมายที่โฮสต์ คุณทำให้ Node.js ใช้งานได้เป็นแอปพลิเคชันเป้าหมายแบ็กเอนด์ของ Edge |
Node (node) |
ไฟล์ Node.js ซึ่งรวมถึงไฟล์ Node.js หลัก ไฟล์ต้นทางที่เกี่ยวข้อง และทรัพยากร Dependency ของโมดูล |
Python (py) |
สคริปต์ Python ที่อ้างอิงโดยนโยบาย PythonScript ต้องใช้ทรัพยากรในแบบ "Python โดยสมบูรณ์" (ในภาษา Python เท่านั้น) |
WSDL (wsdl) |
ไฟล์ WSDL ที่อ้างอิงโดยนโยบาย SOAPMessageValidation |
XSD (xsd) |
สคีมา XML ที่อ้างอิงโดยนโยบาย SOAPMessageValidation |
XSL Transformations (xsl) |
การแปลง XSLT ที่อ้างอิงโดยนโยบาย XSLTransform |
ตำแหน่งที่ใช้จัดเก็บทรัพยากร
ทรัพยากรสามารถจัดเก็บอยู่ในตำแหน่งใดตำแหน่งหนึ่งจาก 3 ตำแหน่งต่อไปนี้
- การแก้ไขพร็อกซี API: ทรัพยากรจะพร้อมใช้งานสำหรับการแก้ไขพร็อกซี API ที่มีทรัพยากรรวมอยู่ด้วยเท่านั้น เช่น คุณอาจรวมทรัพยากร JavaScript ที่มีการแก้ไขพร็อกซี API เวอร์ชัน 1 จากนั้นเปลี่ยนการใช้งานเพื่อใช้สคริปต์ Python ในพร็อกซีการแก้ไข 2 การแก้ไข 1 มีสิทธิ์เข้าถึงเฉพาะทรัพยากร JavaScript ส่วนเวอร์ชัน 2 มีสิทธิ์เข้าถึงเฉพาะทรัพยากร Python
- สภาพแวดล้อม: เมื่อจัดเก็บในสภาพแวดล้อม (เช่น
test
หรือprod
) ทรัพยากรจะพร้อมใช้งานสำหรับพร็อกซี API ที่ทำให้ใช้งานได้ในสภาพแวดล้อมเดียวกัน - องค์กร: เมื่อจัดเก็บไว้ในองค์กร ทรัพยากรจะพร้อมใช้งานสำหรับพร็อกซี API ที่ทำให้ใช้งานได้ในสภาพแวดล้อมทั้งหมด
ที่เก็บจะใช้ได้ที่ URI ต่อไปนี้ ตามที่อธิบายไว้ใน Resource files API และต่อมาในส่วนจัดการทรัพยากรโดยใช้ API
- องค์กร:
/organizations/{org}/resourcefiles
- สภาพแวดล้อม:
/organizations/{org}/environments/{env}/resourcefiles
- พร็อกซี API:
/organizations/{org}/apis/{api}/revisions/{rev}/resources
ตารางต่อไปนี้แสดงวิธีที่คุณใช้สร้าง อัปเดต และลบทรัพยากรของที่เก็บแต่ละรายการได้
ที่เก็บ | สร้าง | ดู | อัปเดต | ลบ | ||||
---|---|---|---|---|---|---|---|---|
API | UI | API | UI | API | UI | API | UI | |
การแก้ไขพร็อกซี API | ||||||||
สภาพแวดล้อม | ||||||||
องค์กร |
เช่น ไฟล์ JavaScript ทั้งหมดที่พร้อมใช้งานในสภาพแวดล้อม test
จะจัดเก็บอยู่ในที่เก็บต่อไปนี้ และพร้อมใช้งานในพร็อกซี API ทั้งหมดที่ทำงานในสภาพแวดล้อม test
/organizations/{org}/environments/test/resourcefiles/jsc
การแปลงชื่อทรัพยากร
Edge จะแก้ไขชื่อทรัพยากรจากขอบเขตที่เฉพาะเจาะจงที่สุดไปยังขอบเขตทั่วไปมากที่สุด ชื่อทรัพยากรได้รับการแก้ไขแบบ "ยกระดับเชน" จากระดับการแก้ไขพร็อกซี API ระดับสภาพแวดล้อม ไปจนถึงระดับองค์กร (Edge เท่านั้น)
สมมติว่าคุณป้อนข้อมูลทรัพยากรเดียวกันในที่เก็บที่ต่างกัน 2 รายการ ได้แก่ การแก้ไขพร็อกซี API และสภาพแวดล้อม prod
ลองใช้พร็อกซี API ที่กำหนดค่าด้วยนโยบายต่อไปนี้
<Javascript name='PathSetterPolicy' timeLimit='200'> <ResourceURL>jsc://pathSetter.js</ResourceURL> </Javascript>
ไม่สามารถแก้ไขการอ้างอิงนโยบายเป็นที่เก็บอย่างชัดแจ้ง ทรัพยากรแรกที่มีขอบเขตละเอียดที่สุดซึ่งมีชื่อตรงกับชื่อทรัพยากรในนโยบายได้รับการแก้ไขแล้ว
ดังนั้นเมื่อมีการทำให้พร็อกซี API ใช้งานได้ในสภาพแวดล้อม prod
นโยบายจะแก้ไขเป็นทรัพยากร pathSetter.js
ที่กำหนดขอบเขตสภาพแวดล้อม
เมื่อทำให้ใช้งานได้ในสภาพแวดล้อม test
นโยบายจะแก้ไขเป็นทรัพยากรที่มีขอบเขตการแก้ไขพร็อกซี API เนื่องจากทรัพยากรที่กำหนดขอบเขตสภาพแวดล้อมอยู่ในสภาพแวดล้อม prod
ไม่ใช่สภาพแวดล้อม test
หลักเกณฑ์ด้านทรัพยากร Java
คุณเพิ่มทรัพยากร Java ที่คอมไพล์แล้วเป็นไฟล์ JAR ได้โดยใช้ตัวเลือกหลายรายการใน curl เช่น ตัวเลือก -T
, --data-binary
หรือ -F
(ไม่ใช่ตัวเลือก -d
) เช่น
curl "http://{mgmt_server}:{port}/v1/organizations/{org}/environments/{env}/resourcefiles?name={jar_file}&type=java" \ -X POST \ --data-binary @{jar_file} \ -H "Content-Type: application/octet-stream" \ -u email:password
curl -v "http://{mgmt_server}:{port}/v1/organizations/{org}/environments/{env}/resourcefiles?name={jar_file}&type=java" -X POST \ -H "Content-Type: application/octet-stream" \ -T "{jar_file}" \ -u email:password
curl -v "http://{mgmt_server}:{port}/v1/organizations/{org}/environments/{env}/resourcefiles?name={jar_file}&type=java" -X POST \ -H "Content-Type: application/multipart/form-data" \ -F "file=@{jar_file}" \ -u email:password
ดูเพิ่มเติม
- แนวทางปฏิบัติแนะนำสำหรับ Java: แนวทางปฏิบัติแนะนำสำหรับการออกแบบและพัฒนาพร็อกซี API
- ตัวอย่างตำราอาหาร Java: นโยบายการแปลง XSL
หลักเกณฑ์ด้านทรัพยากร Node.js
เมื่ออ้างอิงสคริปต์ Node.js ในพร็อกซี API คุณจะอ้างอิงด้วยองค์ประกอบ <ResourceURL>
ในการกำหนดค่า TargetEndpoint
ของพร็อกซี API ตามที่อธิบายไว้ในส่วนการเพิ่ม Node.js ในพร็อกซี API ที่มีอยู่ เช่น
<ScriptTarget> <ResourceURL>node://hello-world.js</ResourceURL> </ScriptTarget>
สคริปต์ Node.js และโมดูลสนับสนุนทั้งหมดต้องอยู่ในขอบเขตการแก้ไขพร็อกซี API (ในไดเรกทอรี /resources/node
ของแพ็กเกจพร็อกซี) ในตัวแก้ไขพร็อกซี API การเพิ่มทรัพยากร Node.js ลงในส่วนสคริปต์ช่วยให้ดำเนินการดังกล่าวได้ เช่นเดียวกับการใช้ API (importและอัปเดต) เพื่อจัดเก็บทรัพยากรในขอบเขตการแก้ไขพร็อกซี API
จัดการทรัพยากรโดยใช้ UI
จัดการทรัพยากรที่กำหนดขอบเขตเป็นการแก้ไขพร็อกซี API โดยใช้ UI ดังที่อธิบายในส่วนต่อไปนี้
ดูทรัพยากรโดยใช้ UI
วิธีดูทรัพยากรที่กำหนดขอบเขตเป็นการแก้ไขพร็อกซี API
-
ลงชื่อเข้าใช้ apigee.com/edge
- เลือกพัฒนา > พร็อกซี API ในแถบนำทางด้านซ้าย
- เลือกพร็อกซี API ในรายการที่คุณต้องการสร้างทรัพยากร
ตัวแก้ไขพร็อกซี API จะเปิดขึ้นและแท็บภาพรวมจะปรากฏขึ้นโดยค่าเริ่มต้น - คลิกแท็บพัฒนา
- เลือกการแก้ไขในเมนูแบบเลื่อนลงการแก้ไข หากจำเป็น
ทรัพยากรที่กำหนดขอบเขตการแก้ไขพร็อกซี API จะแสดงอยู่ในส่วนทรัพยากรในมุมมองตัวนำทาง
สร้างทรัพยากรโดยใช้ UI
วิธีสร้างทรัพยากรที่กำหนดขอบเขตเป็นการแก้ไขพร็อกซี API โดยใช้ UI
- ดูทรัพยากรที่กำหนดขอบเขตไว้สำหรับการแก้ไขพร็อกซี API
- คลิก + ในส่วนทรัพยากรในมุมมองตัวนำทางเพื่อเปิดกล่องโต้ตอบสำหรับทรัพยากรใหม่
- ป้อนข้อมูลต่อไปนี้
ฟิลด์ คำอธิบาย แหล่งที่มา เลือกเพื่อสร้างไฟล์ใหม่หรือนำเข้าไฟล์ ประเภทไฟล์ เลือกประเภททรัพยากรจากรายการแบบเลื่อนลง ชื่อไฟล์ ชื่อไฟล์ นามสกุลไฟล์ต้องเป็นนามสกุลที่ถูกต้องสำหรับประเภทไฟล์ที่เลือก
อัปเดตทรัพยากรโดยใช้ UI
หากต้องการอัปเดตทรัพยากรที่กำหนดขอบเขตเป็นการแก้ไขพร็อกซี API โดยใช้ UI ให้ทำดังนี้
- ดูทรัพยากรที่กำหนดขอบเขตไว้สำหรับการแก้ไขพร็อกซี API
- ในมุมมองตัวนำทางภายใต้ทรัพยากร ให้คลิกทรัพยากรที่คุณต้องการอัปเดต
หมายเหตุ: สำหรับไฟล์ JAR ให้วางเคอร์เซอร์เหนือทรัพยากรที่ต้องการแก้ไข แล้วคลิก - อัปเดตทรัพยากรตามต้องการ
หมายเหตุ: หลังจากอัปโหลดไฟล์ JAR ใหม่แล้ว ให้คลิกอัปเดต
ลบทรัพยากรโดยใช้ UI
วิธีปลดทรัพยากรที่กำหนดขอบเขตเป็นการแก้ไขพร็อกซี API โดยใช้ UI มีดังนี้
- ดูทรัพยากรที่กำหนดขอบเขตไว้สำหรับการแก้ไขพร็อกซี API
- ในมุมมองตัวนำทางภายใต้ทรัพยากร ให้วางเคอร์เซอร์เหนือทรัพยากรที่คุณต้องการลบเพื่อแสดงเมนูการทำงาน
- คลิก
- คลิกลบเพื่อยืนยันการดำเนินการ
จัดการทรัพยากรโดยใช้ API
จัดการทรัพยากรโดยใช้ API ตามที่อธิบายไว้ในส่วนต่อไปนี้
สร้างทรัพยากรโดยใช้ API
สร้างทรัพยากรที่มีขอบเขตเป็นการแก้ไขพร็อกซี API, สภาพแวดล้อม หรือองค์กร (Edge เท่านั้น) ตามที่อธิบายในส่วนถัดไป
สร้างทรัพยากรที่กำหนดขอบเขตเป็นการแก้ไขพร็อกซี API โดยใช้ API
สร้างทรัพยากรที่กำหนดขอบเขตการแก้ไขพร็อกซี API โดยใช้ API โดยการส่งคำขอ POST
ไปยังทรัพยากรต่อไปนี้
https://api.enterprise.apigee.com/v1/organizations/{org}/apis/{api}/revisions/{rev}/resourcefiles
ส่งต่อข้อมูลต่อไปนี้ไปกับคำขอของคุณ
- ตั้งค่าพารามิเตอร์การค้นหา
name
เป็นชื่อของทรัพยากร - ตั้งค่าพารามิเตอร์การค้นหา
type
เป็น resource type ที่จำเป็น - ส่งเนื้อหาของไฟล์ทรัพยากรเป็น
application/octet-stream
หรือmultipart/form-data
)
ตัวอย่างต่อไปนี้สร้างไฟล์ JavaScript ชื่อ pathSetter.js
สำหรับการแก้ไข 1 ของพร็อกซี API ของ helloworld
curl -X POST https://api.enterprise.apigee.com/v1/organizations/myorg/apis/helloworld/revisions/1/resourcefiles?name=pathSetter.js&type=jsc -H "Content-type:application/octet-stream" \ -d 'request.headers["RequestPath"] = context.getVariable("proxy.basepath");' \ -u email:password
ตัวอย่างต่อไปนี้แสดงวิธีอัปโหลดทรัพยากรเป็นไฟล์จากเครื่องภายใน การใช้ -F
สําหรับการอัปโหลดไบนารีใน curl คือการที่นโยบาย JavaScript เข้าถึงไฟล์ JavaScript ในขอบเขตระดับสภาพแวดล้อมหรือองค์กรได้
curl -X POST https://api.enterprise.apigee.com/v1/organizations/myorg/apis/helloworld/revisions/1/resourcefiles?name=pathSetter.js&type=jsc -H "Content-type:multipart/form-data" \ -F file=@pathSetter.js \ -u email:password
ต่อไปนี้เป็นตัวอย่างการตอบสนองจากการเรียก API
{
"name": "pathSetter.js",
"type": "jsc"
}
ดูข้อมูลเพิ่มเติมได้ที่นำเข้าไฟล์ทรัพยากรสำหรับการแก้ไขพร็อกซี API
หรือคุณจะใช้ API การแก้ไขพร็อกซีของ Update API ก็ได้ ดังนี้
- สร้างไฟล์ทรัพยากร
- เพิ่มไฟล์ทรัพยากรลงในกลุ่มการกำหนดค่าพร็อกซี API
- อัปโหลดแพ็กเกจโดยใช้ API รายการใดรายการหนึ่งต่อไปนี้
สร้างทรัพยากรที่กำหนดขอบเขตไว้สำหรับสภาพแวดล้อมโดยใช้ API
สร้างทรัพยากร JavaScript ที่กำหนดขอบเขตไว้สำหรับสภาพแวดล้อมโดยใช้ API โดยการส่งคำขอ POST
ไปยังทรัพยากรต่อไปนี้
/organizations/{org}/environments/{env}/resourcefiles
ส่งต่อข้อมูลต่อไปนี้ไปกับคำขอของคุณ
- ตั้งค่าพารามิเตอร์การค้นหา
name
เป็นชื่อของทรัพยากร - ตั้งค่าพารามิเตอร์การค้นหา
type
เป็น resource type ที่จำเป็น - ส่งเนื้อหาของไฟล์ทรัพยากรเป็น
application/octet-stream
หรือmultipart/form-data
)
ตัวอย่างต่อไปนี้แสดงวิธีสร้างทรัพยากร JavaScript โดยส่งเนื้อหาในเนื้อหาของคำขอ
curl -X POST https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/resourcefiles?name=pathSetter.js&type=jsc -H "Content-type:application/octet-stream" \ -d 'request.headers["RequestPath"] = context.getVariable("proxy.basepath");' \ -u email:password
ตัวอย่างต่อไปนี้แสดงวิธีอัปโหลดทรัพยากรเป็นไฟล์จากเครื่องภายใน การใช้ -F
สําหรับการอัปโหลดไบนารีใน curl คือการที่นโยบาย JavaScript เข้าถึงไฟล์ JavaScript ในขอบเขตระดับสภาพแวดล้อมหรือองค์กรได้
curl -X POST https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/resourcefiles?name=pathSetter.js&type=jsc -H "Content-type:multipart/form-data" \ -F file=@pathSetter.js \ -u email:password
ตัวอย่างการตอบกลับมีดังนี้
{ "name" : "pathSetter.js", "type" : "jsc" }
สร้างทรัพยากรที่กำหนดขอบเขตเฉพาะองค์กรโดยใช้ API
หากต้องการสร้างทรัพยากรที่กำหนดขอบเขตองค์กรโดยใช้ API ให้ส่งคำขอ POST
ไปยังทรัพยากรต่อไปนี้
https://api.enterprise.apigee.comv1/organizations/{org}/resourcefiles
ส่งต่อข้อมูลต่อไปนี้ไปกับคำขอของคุณ
- ตั้งค่าพารามิเตอร์การค้นหา
name
เป็นชื่อของทรัพยากร - ตั้งค่าพารามิเตอร์การค้นหา
type
เป็นประเภทไฟล์ทรัพยากร (ดูประเภททรัพยากร) - ส่งเนื้อหาของไฟล์ทรัพยากรเป็น
application/octet-stream
หรือmultipart/form-data
)
โปรดดูข้อมูลเพิ่มเติมที่หัวข้อนำเข้าไฟล์ทรัพยากรสำหรับองค์กร
ดูทรัพยากรโดยใช้ API
ส่วนต่อไปนี้อธิบายวิธีดูทรัพยากรโดยใช้ API
ดูแหล่งข้อมูลทั้งหมดที่ใช้ API
เมื่อใช้ API คุณสามารถดูทรัพยากรที่มีขอบเขตเป็นการแก้ไขพร็อกซี API, สภาพแวดล้อม หรือองค์กร
เช่น หากต้องการดูทรัพยากรที่กำหนดขอบเขตไปยังสภาพแวดล้อมที่ใช้ API ให้ส่งคำขอ GET
ไปยังทรัพยากรต่อไปนี้
https://api.enterprise.apigee.com/v1/organizations/{org}/environments/{env}/resourcefiles
ตัวอย่างต่อไปนี้แสดงทรัพยากรทั้งหมดในสภาพแวดล้อม test
curl -X GET "https://api.enterprise.apigee.com/v1/organizations/my-organization/environments/test/resourcefiles/{type}" \ -u email:password
ต่อไปนี้เป็นตัวอย่างคำตอบ
{
"resourceFile": [
{
"name" : "pathSetter.js",
"type" : "jsc"
}
]
}
ดูเนื้อหาของทรัพยากรโดยใช้ API
ดูเนื้อหาของทรัพยากรโดยใช้ API ตามที่อธิบายไว้ในส่วนต่อไปนี้
เมื่อใช้ API คุณสามารถดูทรัพยากรที่มีขอบเขตเป็นการแก้ไขพร็อกซี API, สภาพแวดล้อม หรือองค์กร
เช่น หากต้องการดูเนื้อหาของทรัพยากรในสภาพแวดล้อมโดยใช้ API ให้ส่งคำขอ GET
ไปยังทรัพยากรต่อไปนี้
https://api.enterprise.apigee.com/v1/organizations/{org}/environments/{env}/resourcefiles/{type}/name
ตัวอย่างต่อไปนี้แสดงเนื้อหาของไฟล์ทรัพยากร JavaScript pathSetter.js
ในสภาพแวดล้อม test
curl -X GET https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/resourcefiles/jsc/pathSetter.js" \ -H "Accept: application/json" \ -u email:password
ตัวอย่างการตอบกลับมีดังนี้
request.headers["RequestPath"] = context.getVariable("proxy.basepath");
อัปเดตทรัพยากรโดยใช้ API
อัปเดตทรัพยากรที่มีขอบเขตเป็นการแก้ไขพร็อกซี API, สภาพแวดล้อม หรือองค์กร (Edge เท่านั้น) ตามที่อธิบายในส่วนถัดไป
อัปเดตทรัพยากรที่กำหนดขอบเขตการแก้ไขพร็อกซี API โดยใช้ API
อัปเดตทรัพยากรที่กำหนดขอบเขตการแก้ไขพร็อกซี API โดยใช้ API ด้วยการส่งคำขอ PUT
ไปยังทรัพยากรต่อไปนี้
https://api.enterprise.apigee.com/v1/organizations/{org}/apis/{api}/revisions/{rev}/resourcefiles/{type}/{name}
ส่งเนื้อหาของไฟล์ทรัพยากรเป็น application/octet-stream
หรือ multipart/form-data
)
ตัวอย่างต่อไปนี้อัปเดตทรัพยากร JavaScript ชื่อ pathSetter
สำหรับการแก้ไข 1 ของพร็อกซี API ของ helloworld
curl -X PUT https://api.enterprise.apigee.com/v1/organizations/myorg/apis/helloworld/revisions/1/resourcefiles/jsc/pathSetter.js -H "Content-type:application/octet-stream" \ -d 'request.headers["RequestPath"] = context.getVariable("proxy.basepath");' \ -u email:password
ตัวอย่างต่อไปนี้แสดงวิธีอัปเดตทรัพยากรเป็นไฟล์จากเครื่องภายใน การใช้ -F
สําหรับการอัปโหลดไบนารีใน curl คือการที่นโยบาย JavaScript เข้าถึงไฟล์ JavaScript ในขอบเขตระดับสภาพแวดล้อมหรือองค์กรได้
curl -X PUT https://api.enterprise.apigee.com/v1/organizations/myorg/apis/helloworld/revisions/1/resourcefiles/jsc/pathSetter.js -H "Content-type:multipart/form-data" \ -F file=@pathSetter.js \ -u email:password
ต่อไปนี้เป็นตัวอย่างการตอบสนองจากการเรียก API
{
"name": "pathSetter.js",
"type": "jsc"
}
ดูข้อมูลเพิ่มเติมได้ที่นำเข้าไฟล์ทรัพยากรสำหรับการแก้ไขพร็อกซี API
หรือคุณจะใช้ API การแก้ไขพร็อกซีของ Update API ก็ได้ ดังนี้
- ดาวน์โหลดกลุ่มการกำหนดค่าพร็อกซี API โดยใช้ Export API Proxy API โดยใช้ตัวเลือกต่อไปนี้
- ตั้งค่าพารามิเตอร์การค้นหา
format
เป็นbundle
- ตั้งค่าส่วนหัว
Accept
เป็นapplication/zip
- ตั้งค่าพารามิเตอร์การค้นหา
- อัปเดตไฟล์ทรัพยากรในกลุ่มการกำหนดค่าพร็อกซี API
- อัปโหลดแพ็กเกจโดยใช้ API การแก้ไขพร็อกซี API
อัปเดตทรัพยากรที่กำหนดขอบเขตไปยังสภาพแวดล้อมโดยใช้ API
อัปเดตทรัพยากรที่กำหนดขอบเขตเป็นสภาพแวดล้อมโดยใช้ API โดยการส่งคำขอ PUT
ไปยังทรัพยากรต่อไปนี้
/organizations/{org}/environments/{env}/resourcefiles/{type}/{name}
ส่งเนื้อหาของไฟล์ทรัพยากรเป็น application/octet-stream
หรือ multipart/form-data
ตัวอย่างต่อไปนี้แสดงวิธีอัปเดตทรัพยากร JavaScript โดยส่งผ่านเนื้อหาในเนื้อหาของคำขอ
curl -X PUT https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/resourcefiles/jsc/pathSetter.js -H "Content-type:application/octet-stream" \ -d 'request.headers["RequestPath"] = context.getVariable("proxy.basepath");' \ -u email:password
ตัวอย่างต่อไปนี้แสดงวิธีอัปเดตไฟล์ทรัพยากรโดยใช้ไฟล์จากเครื่องภายใน การใช้ -F
สําหรับการอัปโหลดไบนารีใน curl คือการที่นโยบาย JavaScript เข้าถึงไฟล์ JavaScript ในขอบเขตระดับสภาพแวดล้อมหรือองค์กรได้
curl -X PUT https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/resourcefiles/jsc/pathSetter.js -H "Content-type:multipart/form-data" \ -F file=@pathSetter.js \ -u email:password
ตัวอย่างการตอบกลับมีดังนี้
{ "name" : "pathSetter.js", "type" : "jsc" }
อัปเดตทรัพยากรที่กำหนดขอบเขตเฉพาะองค์กรโดยใช้ API
หากต้องการอัปเดตทรัพยากรที่อยู่ในขอบเขตขององค์กรโดยใช้ API ให้ส่งคำขอ POST
ไปยังทรัพยากรต่อไปนี้
https://api.enterprise.apigee.comv1/organizations/{org}/resourcefiles/{type}/{name}
ส่งเนื้อหาของไฟล์ทรัพยากรเป็น application/octet-stream
หรือ multipart/form-data
)
สำหรับข้อมูลเพิ่มเติม โปรดดูนำเข้าไฟล์ทรัพยากรสำหรับองค์กร
ลบทรัพยากรโดยใช้ API
ลบทรัพยากรที่กำหนดขอบเขตเป็นการแก้ไขพร็อกซี API, สภาพแวดล้อม หรือองค์กร (Edge เท่านั้น) ตามที่อธิบายในส่วนถัดไป
ลบทรัพยากรที่กำหนดขอบเขตการแก้ไขพร็อกซี API โดยใช้ API
หากต้องการลบทรัพยากรที่กำหนดขอบเขตการแก้ไขพร็อกซี API โดยใช้ API ให้ส่งคำขอ DELETE
ไปยังทรัพยากรต่อไปนี้
https://api.enterprise.apigee.com/v1/organizations/{org}/apis/{api}/revisions/{rev}/resourcefiles/{type}/{name}
ตัวอย่างต่อไปนี้จะลบไฟล์ทรัพยากร JavaScript pathSetter.js
ออกจากการแก้ไขที่ 1 ของพร็อกซี helloworld API
curl -X GET "https://api.enterprise.apigee.com/v1/organizations/my-organization/apis/helloworld/revisions/1/resourcefiles/jsc/pathSetter.js" \ -u email:password
ต่อไปนี้เป็นตัวอย่างคำตอบ
{
"name" : "pathSetter.js",
"type" : "jsc"
}
หรือคุณจะใช้ API การแก้ไขพร็อกซีของ Update API ก็ได้ ดังนี้
- ดาวน์โหลดกลุ่มการกำหนดค่าพร็อกซี API โดยใช้ Export API Proxy API โดยใช้ตัวเลือกต่อไปนี้
- ตั้งค่าพารามิเตอร์การค้นหา
format
เป็นbundle
- ตั้งค่าส่วนหัว
Accept
เป็นapplication/zip
- ตั้งค่าพารามิเตอร์การค้นหา
- ลบไฟล์ทรัพยากรออกจากกลุ่มการกำหนดค่าพร็อกซี API
- อัปโหลดแพ็กเกจโดยใช้ API การแก้ไขพร็อกซี API
ลบทรัพยากรที่กำหนดขอบเขตไว้สำหรับสภาพแวดล้อมโดยใช้ API
ลบทรัพยากรที่กำหนดขอบเขตเฉพาะสภาพแวดล้อมโดยใช้ API ดังที่อธิบายไว้ในส่วนต่อไปนี้
หากต้องการลบทรัพยากรที่กำหนดขอบเขตไว้สำหรับสภาพแวดล้อมโดยใช้ API ให้ส่งคำขอ DELETE
ไปยังทรัพยากรต่อไปนี้
https://api.enterprise.apigee.com/v1/organizations/{org}/environments/{env}/resourcefiles/{type}/{name}
ตัวอย่างต่อไปนี้จะลบไฟล์ทรัพยากร JavaScript pathSetter.js
ออกจากสภาพแวดล้อม test
curl -X GET "https://api.enterprise.apigee.com/v1/organizations/my-organization/environments/test/resourcefiles/jsc/pathSetter.js" \ -u email:password
ต่อไปนี้เป็นตัวอย่างคำตอบ
{
"name" : "pathSetter.js",
"type" : "jsc"
}
ลบทรัพยากรที่กำหนดขอบเขตเฉพาะองค์กรโดยใช้ API (Edge เท่านั้น)
หากต้องการลบทรัพยากรที่อยู่ในขอบเขตขององค์กรโดยใช้ API ให้ส่งคำขอ DELETE
ไปยังทรัพยากรต่อไปนี้
https://api.enterprise.apigee.comv1/organizations/{org}/resourcefiles/{type}/{name}
โปรดดูข้อมูลเพิ่มเติมในหัวข้อลบไฟล์ทรัพยากรออกจากองค์กร
เข้าถึงทรัพยากร
วิธีเข้าถึงทรัพยากรจะขึ้นอยู่กับประเภททรัพยากร อ่านข้อมูลเพิ่มเติมได้ในเอกสารนโยบายที่เกี่ยวข้อง
ตัวอย่างในส่วนนี้แสดงวิธีสร้างและจัดการทรัพยากร JavaScript ชื่อ pathSetter.js
เพื่ออนุญาตให้นโยบายประเภท JavaScript อ้างอิงทรัพยากรดังกล่าว
หากต้องการแนบ JavaScript กับ PostFlow ของคําขอ ให้สร้างนโยบายชื่อ PathSetterPolicy.xml
ที่อ้างอิงไฟล์ pathSetter.js
ดังนี้
<Javascript name='PathSetterPolicy' timeLimit='200'> <ResourceURL>jsc://pathSetter.js</ResourceURL> </Javascript>
จากนั้น อ้างอิงนโยบายในการกำหนดค่าปลายทางดังนี้
<PostFlow> <Request> <Step><Name>PathSetterPolicy</Name></Step> </Request> <PostFlow>
ดูข้อมูลเพิ่มเติมได้ที่นโยบาย JavaScript