如何使用Markdown在Swagger模型描述中工作？

Question

我正試圖在Swagger中爲模型項添加額外的信息。該文檔說GFM語法可以用在描述字段中，但這不適用於所有地方。

這是問題的一個最小虛擬例如：

swagger: '2.0' 
info: 
    title: Example API 
    description: (1) This is the API description containing some *rich* **text** 
    version: "1.0.0" 
paths: 
    /products: 
    get: 
     summary: Product Types 
     description: (2) This is the path description also containing some *rich* **text** 

     responses: 
     200: 
      description: (3) This is a response description also containing some *rich* **text** 
      schema: 
      type: array 
      items: 
       $ref: '#/definitions/Product' 

definitions: 
    Product: 
    description: (4) This is a model description where *rich* **text** does not work 
    type: object 
    properties: 
     product_id: 
     type: string 
     description: (5) This is a field description where *rich* **text** does not work 

的schema object documentation說，我應該能夠在標記爲（4）之上，但沒有地方用降價說一下地方（5）。

我想將Markdown添加到模型部分中兩個位置中的任意一個。我怎樣才能使這個工作？

Answer 1

Swagger編輯器在模型描述中不支持Markdown。從https://github.com/swagger-api/swagger-editor/issues/682：

對於渲染JSON Schema對象，我們使用的是不支持Markdown的json-schema-view-js lib。 Swagger編輯器不能改變這個庫的行爲，這種行爲並不常見於添加到庫中。

如果你需要這個功能，你可以叉swagger-editor和/或json-schema-view-js和執行功能/修復自己，然後提交pull請求。