swagger คือเครื่องมือที่เอาไว้ช่วยในการสร้างเอกสารหรือคู่มือสำหรับ rest api สำหรับในบทความนี้เราจะมาลองใช้ swagger กัน
แต่ก่อนที่จะไปใช้กันจำเป็นต้องมี 2 สิ่งเพื่อที่จะใช้
- Swagger Editor
- api ที่เราจะนำมาทดสอบ
ซึ่งในการติดตั้ง swagger editor เราจะติดตั้งบน docker กันหรือหากไม่อยากติดตั้งสามารถเข้าไปใช้ ผ่านลิ้งค์นี้ได้เลย SwaggerEditor
ก่อนอื่นก็มาติดตั้ง swagger editor กันก่อนให้ใช้คำสั่ง
docker pull swaggerapi/swagger-editorถัดมาก็ทำการ run docker image ด้วยคำสั่ง
docker run -d -p 80:8000 swaggerapi/swagger-editorเมื่อเข้ามาหน้าแรกจะเป็นตามภาพด้านล่างเลย จะมี api ตัวอย่างให้ทดลองใช้อยู่
แต่ในบทความนี้เราได้เตรียม api มาทดสอบเองดังนั้นจะไม่ใช้ตัวอย่างของทาง swagger
1. ขั้นแรกก็ทำการกำหนด version ของ swagger ก่อนซึ่งในบทความนี้จะใช้เป็น swagger 2.0
2. เมื่อกำหนด version เสร็จก็มาใส่รายละเอียดของ rest api จากนั้นใส่ host ของ api ที่เราเตรียมมาไว้ทดสอบ และทำการใส่ protocal สามารถใส่ได้มากกว่าหนึ่งค่า
3. จากนั้นมาสร้าง path เพื่อใช้ทดสอบ
4. เมื่อสร้าง path เสร็จแล้วก็มาที่หน้าจอฝั่งขวาเพื่อทำการทดสอบ ในการทดสอบให้กดที่ try it out แล้วกด execute ก็จะได้ผลลัพธ์ดังภาพ
ไม่มีความคิดเห็น:
แสดงความคิดเห็น