Swagger สำหรับเอกสาร API

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

คุณสมบัติผยอง

เอกสารประกอบของ Swagger มีคุณสมบัติมากมาย รวมถึง:

1. เอกสารเชิงโต้ตอบ: อนุญาตให้นักพัฒนาทดลองใช้การเรียก API และดูการตอบสนองใน UI บนเบราว์เซอร์
2. คำจำกัดความของ API: ให้คำจำกัดความที่ชัดเจน กระชับ และเป็นมิตรกับมนุษย์เกี่ยวกับสิ่งที่ API ทำ จุดสิ้นสุด พารามิเตอร์ และการตอบสนองที่คาดหวัง
3. การสร้างรหัส: สร้างรหัสเซิร์ฟเวอร์และไคลเอ็นต์ในภาษาการเขียนโปรแกรมหลายภาษาเพื่อช่วยเร่งกระบวนการพัฒนา
4. การตรวจสอบ: ตรวจสอบคำขอและการตอบกลับ API โดยอัตโนมัติเพื่อให้แน่ใจว่าตรงตามข้อกำหนดของ API
5. การสร้างเอกสาร: สร้างเอกสารประกอบ API โดยอัตโนมัติในรูปแบบต่างๆ รวมถึง HTML, JSON และ YAML
6. การทำงานร่วมกัน: รองรับการทำงานร่วมกันระหว่างผู้สร้าง API นักพัฒนา และผู้มีส่วนได้ส่วนเสีย โดยจัดเตรียมตำแหน่งส่วนกลางสำหรับเอกสาร API
7. การทดสอบ: จัดเตรียมสภาพแวดล้อมสำหรับการทดสอบการเรียก API และตรวจสอบให้แน่ใจว่าเป็นไปตามลักษณะการทำงานที่ต้องการ
8. การกำหนดเวอร์ชัน: รองรับการกำหนดเวอร์ชันของ API และอนุญาตให้ผู้ใช้ดูและทำงานกับ API หลายเวอร์ชัน

เอกสาร Swagger รองรับภาษาการเขียนโปรแกรมหลายภาษา ได้แก่ :

1. ชวา
2. โหนด js
3. พี.เอช.พี
4. หลาม
5. ทับทิม
6. ไป
7. ค#
8. สกาลา
9. เพิร์ล

เปิดใช้งาน Swagger ใน Spring boot

ในการเปิดใช้งานเอกสาร Swagger ในแอปพลิเคชันสปริงบูต คุณต้องทำตามขั้นตอนเหล่านี้:

1. เพิ่มการอ้างอิง springfox-swagger2 และ springfox-swagger-ui ให้กับโครงการ
2. เปิดใช้งานการสนับสนุน Swagger ในแอปพลิเคชัน Spring Boot โดยใส่คำอธิบายประกอบคลาสการกำหนดค่าของคุณด้วย @EnableSwagger2
3. สร้าง Docket bean เพื่อกำหนดค่าคุณสมบัติ Swagger เช่น เวอร์ชัน API ชื่อ และคำอธิบาย
4. ใส่คำอธิบายประกอบ RESTful API ของคุณด้วยคำอธิบายประกอบ Swagger ที่เหมาะสม เช่น @Api, @ApiOperation, @ApiParam เป็นต้น
5. เรียกใช้แอปพลิเคชัน Spring Boot และเข้าถึง Swagger UI ที่ URLhttp://localhost:port/swagger-ui.htmlโดยที่พอร์ตคือพอร์ต HTTP ที่แอปพลิเคชันของคุณทำงานอยู่

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }
}

การตั้งค่า Swagger 2 ด้วย Spring REST API | มะตูม

การจัดทำเอกสาร Spring REST API โดยใช้ OpenAPI 3.0 | มะตูม