หน้าแรก>การเขียนโปรแกรมที่เกี่ยวข้อง>ซอร์สโค้ดเดลฟี
ดาวน์โหลด

swagdoc

Swagdoc เป็นไลบรารี Delphi เพื่อสร้างไฟล์ Swagger.json สำหรับ Swagger Spec เวอร์ชัน 2.0 สร้างเอกสารสาธารณะ REST API โดยใช้ Swagger 2.0 สำหรับภาษา Delphi ความรับผิดชอบเพียงอย่างเดียวของ Swagdoc คือการสร้างไฟล์ Swagger.json ไฟล์ Swagger.json มีหน้าที่รับผิดชอบในการบรรจุเอกสารทั้งหมดสำหรับ REST API ของคุณ ไฟล์นี้จะต้องแนบกับไฟล์ Swagger UI (ส่วนต่อประสานผู้ใช้)

ปุ่มบริจาค PayPal

Swagger (Open API) - เวอร์ชัน 2.0

Swagdoc ติดตามข้อมูลจำเพาะ 2.0 เนื่องจากเป็นที่นิยมมากขึ้นในตลาดและเพราะมันถือว่าเป็นรุ่นที่มีเสถียรภาพมากขึ้นที่จะมีความยาวที่สุด Swagdoc ยังไม่สนับสนุนเวอร์ชัน Swagger 3.0 แต่ขึ้นอยู่กับความต้องการและการมีส่วนร่วมในโครงการที่อาจพัฒนาเพื่อสนับสนุน Spec 3.0

ข้อกำหนดเบื้องต้นหลักสำหรับการทำงานกับ Swagdoc คือการรู้ถึงข้อกำหนด Swagger 2.0 ที่สามารถดูได้ในลิงค์ด้านล่าง

https://github.com/oai/openapi-specification/blob/master/versions/2.0.md

https://swagger.io/docs/specification/2-0/basic-structure/

เมื่อสร้างเอกสาร Swagger สำหรับ REST API ของคุณคุณสามารถสร้างหน้าเว็บเช่นตัวอย่างต่อไปนี้

https://app.swaggerhub.com/apis-docs/swagdoc/sample-api/v1

ภาพ

สคีมา JSON

https://github.com/oai/openapi-specification/blob/master/versions/2.0.md#schemaobject

http://json-schema.org

Swagdoc กล่าวสุนทรพจน์

https://www.youtube.com/watch?v=9U3HP3B5UT0 (PT-BR)

https://www.youtube.com/watch?v=PHGMQAD8O6C (PT-BR)

การอ้างอิงและบทช่วยสอน

https://swagger.io/swagger/media/blog/wp-content/uploads/2017/02/documenting-an-existing-api-with-swagger-2.pdf

https://idratherbewriting.com/learnapidoc/pubapis_swagger_intro.html

เครื่องมือ Swagger

  • Swagger: https://swagger.io

  • Swagger Editor: https://editor.swagger.io

  • Swagger Hub: https://swagger.io/tools/swaggerhub

  • ตัวอย่าง Swagger คลาสสิก: http://petstore.swagger.io

  • เครื่องมือและการบูรณาการ: https://swagger.io/tools/open-source/open-source-integrations

ไฟล์แจกจ่าย UI Swagger

เพื่อให้คุณสร้างหน้าเว็บที่มีเอกสารประกอบคุณต้องมีไฟล์แจกจ่าย UI Swagger

ไฟล์เหล่านี้คุณสามารถค้นหาได้ในที่เก็บ GitHub Swagger-Api / Swagger-Ui

https://github.com/swagger-api/swagger-ui/tree/master/dist

ภาพ

ก่อนอื่นคุณต้องดาวน์โหลดไฟล์อินเทอร์เฟซผู้ใช้ Swagger และสร้างไฟล์ Swagger.json จากนั้นคุณต้องเปลี่ยนไฟล์ index.html เพื่อระบุเส้นทางสัมพัทธ์ของตำแหน่งที่ไฟล์ swagger.json อยู่บนเว็บเซิร์ฟเวอร์ของคุณที่โฮสต์ไฟล์ส่วนต่อประสานผู้ใช้ Swagger

ดูตัวอย่างด้านล่าง

ภาพ

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