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 文档的内容