在Django Rest Framework的Swagger中顯示最大值，最小值和默認值

我正在爲我的API開發一個v2，並且我想正確記錄它。由於我使用Django Rest Framework（3.1.1），並且在他們的文檔中推薦使用Swagger，所以我正在使用它。在Django Rest Framework的Swagger中顯示最大值，最小值和默認值

在文檔中，我看到它的一個功能是顯示「字段默認值，最小值，最大值，只讀和必需屬性」。然而，在我的例子中，我只看到「說明」，「參數類型」和「數據類型」，如圖片：

我希望看到更多的列，如最小值，最大值，而默認情況下，從型號上所採取的值（不必重寫他們在串行這是我的串行器，在情況下，它可以幫助：

class UserSerializer(serializers.ModelSerializer): 

    class Meta: 
     model = User 
     fields = ('id', 'email', 'first_name', 'last_name', 'password',) 
     write_only_fields = ('password',) 
     read_only_fields = ('id',) 

    def create(self, validated_data): 
    [...]

似乎沒有人有同樣的問題，所以也許（我希望不）我缺少一些微不足道的東西。希望你能幫助。謝謝！

來源

2016-01-04 vabada

class MySourceView(generics.RetrieveUpdateDestroyAPIView): 
    """ 
    MySource documentation 
    """ 
    serializer_class = MySourceSerializer 
    queryset = MySource.objects.all() 

    def get(self, request, *args, **kwargs): 
     """ 
     GET Documentation 
     --- 
      parameters_strategy: replace 
      parameters: 
       - name: pk 
        description: "Liverpool FC is the best." 
        required: true 
        type: string 
        paramType: path 
        defaultValue: 5 
     """ 
     return self.retrieve(request, *args, **kwargs)

您可以在指定方法中將其作爲YAML文檔字符串來執行。更多詳細信息在Swagger RESTful API Documentation Specification 4.3.3數據類型字段

來源

2016-06-20 12:28:40 Marosinho

在Django Rest Framework的Swagger中顯示最大值，最小值和默認值

回答

相關問題