如何使用Django REST Swagger記錄pk參數（或其他路徑參數）？

Question

有沒有一種方法來記錄由Django REST Framework（通過擴展ViewSet）自動生成的pk參數？

實例函數在視圖集中：

class MyViewSet(viewsets.ViewSet): 
    @detail_route(url_path='mypath') 
    def myapi(self): 
     """ 
      first_param -- Param 1 
     """ 
     pass 

如果我在YAML文檔字符串添加一個PK參數，我有一個重複。

Answer 1

pk參數（或任何其他路徑參數）可以使用YAML文檔字符串形成文檔，如documentation of Django REST Swagger中所述。有關屬性列表，請參閱Swagger documentation。

請注意，您必須爲路徑參數指定paramType: path。爲避免重複出現在您的api文檔中，您可以指定parameters_strategy: replace，如here所述。

實施例：

@detail_route(url_path='mypath') 
def myapi(self, request, **kwargs): 
    """ 
    Endpoint documentation. 
    --- 
     parameters_strategy: replace 
     parameters: 
      - name: pk 
       description: "Primary Key" 
       required: true 
       type: string 
       paramType: path 
    """