SwagDoc

Swagdoc

SwagDoc adalah perpustakaan Delphi untuk menghasilkan file wellagger.json untuk Spec Versi 2.0 Spec. Buat API REST Dokumentasi Publik menggunakan Swagger 2.0 untuk bahasa Delphi. Satu -satunya tanggung jawab SwagDoc adalah menghasilkan file wellagger.json. File Swagger.json bertanggung jawab untuk berisi semua dokumentasi untuk API REST Anda. File ini harus dilampirkan ke file Swagger UI (antarmuka pengguna).

Swagger (Open API) - Versi 2.0

Swagdoc mengikuti spesifikasi 2.0 karena lebih populer di pasaran dan juga karena dianggap sebagai versi yang lebih stabil untuk ada paling lama. SwagDoc belum mendukung versi Swagger 3.0, tetapi tergantung pada permintaan dan kontribusi untuk proyek yang dapat dikembangkan untuk mendukung Spec 3.0.

Prasyarat utama untuk bekerja dengan SwagDoc adalah untuk mengetahui spesifikasi Swagger 2.0 yang dapat dilihat di tautan di bawah ini.

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

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

Saat membuat dokumentasi kesombongan untuk API istirahat Anda, Anda dapat menghasilkan halaman seperti contoh berikut.

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

Skema JSON

https://github.com/oai/openapi-pecification/blob/master/versions/2.0.md#schemaObject

http://json-schema.org

Pidato Swagdoc

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

https://www.youtube.com/watch?v=phgmqad8o6c (pt-r)

Referensi dan tutorial Swagger

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

Alat kesombongan

• Swagger: https://swagger.io

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

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

• Sampel Swagger klasik: http://petstore.swagger.io

• Alat dan Integrasi: https://swagger.io/tools/open-source/open-source-integrasi

File distribusi UI Swagger

Agar Anda dapat menghasilkan halaman yang berisi dokumentasi Swagger, Anda memerlukan file distribusi UI Swagger.

File-file ini yang dapat Anda temukan di repositori Github Swagger-API / Swagger-UI.

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

Pertama, Anda perlu mengunduh file antarmuka pengguna Swagger dan menghasilkan file wellagger.json. Anda kemudian perlu mengubah file index.html untuk menunjukkan jalur relatif dari lokasi di mana file swagger.json terletak di server web Anda yang menampung file antarmuka pengguna Swagger.

Lihat contoh di bawah ini.