SwagDoc

斯瓦多克

Swagdoc是一個Delphi庫，用於生成Swagger.json文件，用於Swagger Spec 2.0版。使用Swagger 2.0用於Delphi語言創建公共文檔REST API。 Swagdoc的唯一責任是生成Swagger.json文件。 Swagger.json文件負責包含REST API的所有文檔。該文件必須附加到Swagger UI（用戶界面）文件上。

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-schrenture/

在為您的REST API創建Swagger文檔時，您可以像以下示例一樣生成頁面。

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

斯瓦多克演講

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-with-swagger-swagger-2.pdf

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

炫耀工具

• Swagger：https：//swagger.io

• Swagger編輯：https：//editor.swagger.io

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

• 經典的宣傳樣本：http：//petstore.swagger.io

• 工具和集成：https：//swagger.io/tools/open-source/open-source-integrations

Swagger UI發行文件

為了使您生產一個包含誇張文檔的頁面，您需要Swagger UI發行文件。

您可以在Github Swagger-API / Swagger-UI存儲庫中找到這些文件。

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

首先，您需要下載Swagger用戶界面文件並生成Swagger.json文件。然後，您需要更改index.html文件，以指示Swagger.json文件位於託管Swagger用戶界面文件的位置的相對路徑。

請參閱下面的示例。