3分鐘掌握 DITA 結構化寫作情況下釋出Swagger API 文檔Swagger Endpoint 樣本示例 DITA 輸出前提條件用法相關閱讀

由于最近出現了一些與 API 文檔開發相關的問題，今天我将與您分享如何在 DITA 結構化編寫條件下釋出 Swagger API 文檔。

本文适用于已投資 DITA 并需要閱讀和掌握 Swagger API 文檔開發需求的工程師和主管。

<一個 swagger Endpoint > h1 class""pgc-h-right-arrow" data-track""5" 的樣本</h1>

"路徑"： {

"/pet"： {

"put"： {

"标簽"： [ "寵物" ]，

"摘要"："更新現有寵物"，

"描述"： ""，

"operationId"： "updatePet"，

"consumes"： ["application/json"， "application/xml"]，

"produces"： ["application/xml"， "application/json"]，

"參數"： [

{

"in"： "body"， "name"： "body"， "required"： true，

"描述"："需要添加到商店的寵物對象"，

"schema"： { "$ref"： "#/definitions/Pet" }

}

],

"響應"： {

"400"： {"描述"： "提供的 ID 無效"}，

"404"： {"描述"： "找不到寵物"}，

"405"： {"描述"： "驗證異常"}

},

"安全"： [

"petstore_auth"： ["寫：寵物"，"閱讀：寵物"]

]

<示例 DITA 輸出> h1 類""pgc-h-right-arrow"data-track-"3"</h1>

< >> h1類"pgc-h-arrow right-"data-track"的先決條件。44 英寸</h1>

使用我們公司的DITA OT Swagger插件并安裝它。有興趣，請聯系我們。

< > h1 類"的用法"pgc-h-right-arrow"data-track""34"</h1>

對于 DITA 處理，swagger 檔案可以定義為 json 或 yaml 格式。如果您标記由 Swagger 處理的檔案，請按如下方式标記 format"swagger"：

附加的檔案将轉換為 .dita 檔案并添加到生成作業中，而無需進一步處理。除非被覆寫，否則導航标題包含與檔案根名稱相同的主題。檔案名中的任何下劃線都将替換為标題中的空格。

< h1級""pgc-h-arrow right-"資料跟蹤""40">相關閱讀</h1>

編寫 API 文檔的内容