feat: update api for docs

Author: leafcoder

ncovapi/admin.py

@@ -84,31 +84,30 @@ class RumorAdmin(BaseAdmin):
 class CityAdmin(BaseAdmin):
 
     list_display = (
-        'locationId', 'province', 'cityName', 'currentConfirmedCount',
+        'province', 'cityName', 'currentConfirmedCount',
         'confirmedCount', 'suspectedCount', 'curedCount', 'deadCount'
     )
-    search_fields = ('locationId', 'cityName', 'province__provinceName')
+    search_fields = ('cityName', 'province__provinceName')
 
 
 @admin.register(models.Province)
 class ProvinceAdmin(BaseAdmin):
 
     list_display = (
-        'locationId', 'provinceName', 'currentConfirmedCount',
+        'provinceName', 'currentConfirmedCount',
         'confirmedCount', 'suspectedCount', 'curedCount', 'deadCount'
     )
-    search_fields = ('locationId', 'provinceName')
+    search_fields = ('provinceName', )
 
 
 @admin.register(models.Country)
 class CountryAdmin(BaseAdmin):
 
     list_display = (
-        'locationId', 'continents', 'countryName', 'countryFullName',
+        'continents', 'countryName', 'countryFullName',
         'currentConfirmedCount', 'confirmedCount',
         'suspectedCount', 'curedCount', 'deadCount'
     )
     search_fields = (
-        'locationId', 'continents', 'countryFullName', 'countryShortCode',
-        'countryName'
+        'continents', 'countryFullName', 'countryShortCode', 'countryName'
     )

ncovapi/filters.py

@@ -9,45 +9,39 @@ class CharInFilter(django_filters.BaseInFilter, django_filters.CharFilter):
 
 class CityFilter(django_filters.rest_framework.FilterSet):
 
-    locationId = django_filters.CharFilter(lookup_expr='iexact')
-    provinceName = django_filters.CharFilter(
-        field_name='province__provinceName', lookup_expr='iexact')
-    cityName = django_filters.CharFilter(lookup_expr='iexact')
+    provinceShortNames = CharInFilter(
+        field_name='province__provinceShortName', lookup_expr='in')
     cityNames = CharInFilter(
         field_name='cityName', lookup_expr='in')
 
     class Meta:
         model = City
-        fields = ['locationId', 'provinceName', 'cityName']
+        fields = ['provinceShortNames', 'cityName']
 
 
 class ProvinceFilter(django_filters.rest_framework.FilterSet):
 
-    locationId = django_filters.CharFilter(lookup_expr='iexact')
-    provinceName = django_filters.CharFilter(lookup_expr='iexact')
-    provinceShortName = django_filters.CharFilter(lookup_expr='iexact')
+    provinceShortNames = CharInFilter(
+        field_name='provinceyName', lookup_expr='in')
     provinceNames = CharInFilter(
         field_name='provinceyName', lookup_expr='in')
 
     class Meta:
         model = Province
-        fields = ['id', 'locationId', 'provinceName', 'provinceShortName']
+        fields = ['provinceName', 'provinceShortName']
 
 
 class CountryFilter(django_filters.rest_framework.FilterSet):
 
-    locationId = django_filters.CharFilter(lookup_expr='iexact')
-    continents = django_filters.CharFilter(lookup_expr='iexact')
-    countryShortCode = django_filters.CharFilter(lookup_expr='iexact')
-    countryType = django_filters.CharFilter(lookup_expr='iexact')
-    countryName = django_filters.CharFilter(lookup_expr='iexact')
-    countryFullName = django_filters.CharFilter(lookup_expr='iexact')
+    continents = CharInFilter(
+        field_name='continents', lookup_expr='in')
+    countryShortCodes = CharInFilter(
+        field_name='countryShortCode', lookup_expr='in')
     countryNames = CharInFilter(
         field_name='countryName', lookup_expr='in')
 
     class Meta:
         model = Country
         fields = [
-            'locationId', 'continents', 'countryShortCode', 'countryType',
-            'countryName', 'countryFullName'
+            'continents', 'countryShortCode', 'countryName'
         ]

ncovapi/models.py

@@ -225,11 +225,10 @@ class Meta:
 class Country(models.Model):
 
     locationId = models.IntegerField()
-    continents = models.CharField(max_length=50) # 
-    countryShortCode = models.CharField(max_length=20) #
-    countryType = models.CharField(max_length=20) # 
-    countryName = models.CharField(max_length=50) #
-    countryFullName = models.CharField(max_length=50) #
+    continents = models.CharField(max_length=50)
+    countryShortCode = models.CharField(max_length=20)
+    countryName = models.CharField(max_length=50)
+    countryFullName = models.CharField(max_length=50)
     currentConfirmedCount = models.IntegerField(default=0)
     confirmedCount = models.IntegerField(default=0)
     suspectedCount = models.IntegerField(default=0)

ncovapi/serializers.py

@@ -92,7 +92,7 @@ class ProvinceSerializer(serializers.HyperlinkedModelSerializer):
     class Meta:
         model = Province
         fields = [
-            'locationId', 'provinceName', 'provinceShortName',
+            'provinceName', 'provinceShortName',
             'currentConfirmedCount', 'confirmedCount', 'suspectedCount',
             'curedCount', 'deadCount'
         ]
@@ -103,7 +103,7 @@ class CitySerializer(serializers.ModelSerializer):
     class Meta:
         model = City
         fields = [
-            'locationId', 'provinceName', 'cityName',
+            'provinceName', 'cityName',
             'currentConfirmedCount', 'confirmedCount', 'suspectedCount',
             'curedCount', 'deadCount'
         ]
@@ -113,8 +113,7 @@ class CountrySerializer(serializers.HyperlinkedModelSerializer):
     class Meta:
         model = Country
         fields = [
-            'locationId', 'continents', 'countryShortCode',
-            'countryType', 'countryName', 'countryFullName',
-            'currentConfirmedCount', 'confirmedCount', 'suspectedCount',
-            'curedCount', 'deadCount'
+            'continents', 'countryShortCode', 'countryName',
+            'countryFullName', 'currentConfirmedCount', 'confirmedCount',
+            'suspectedCount', 'curedCount', 'deadCount'
         ]

ncovapi/urls.py

@@ -14,7 +14,7 @@
     path('cities/<str:cityName>/', views.CityRetrieveByNameView.as_view(), name='city-detail-by-name'),
     path('provinces/', views.ProvinceListView.as_view(), name='province-list'),
     path('provinces/<int:pk>/', views.ProvinceRetrieveView.as_view(), name='province-detail'),
-    path('provinces/<str:provinceName>/', views.ProvinceRetrieveByNameView.as_view(), name='province-detail-by-name'),
+    path('provinces/<str:provinceShortName>/', views.ProvinceRetrieveByNameView.as_view(), name='province-detail-by-name'),
     path('countries/', views.CountryListView.as_view(), name='country-list'),
     path('countries/<int:pk>/', views.CountryRetrieveView.as_view(), name='country-detail'),
     path('countries/<str:countryName>/', views.CountryRetrieveByNameView.as_view(), name='country-detail-by-name'),

ncovapi/views.py

@@ -101,20 +101,21 @@ def dispatch(self, *args, **kwargs):
 class ProvinceRetrieveByNameView(APIView):
     """通过省名获取数据"""
 
-    def get_object(self, provinceName):
+    def get_object(self, provinceShortName):
         try:
             crawler = Crawler.objects.order_by('-id').first()
         except Crawler.DoesNotExist:
             raise Http404
         try:
             return Province.objects.filter(
-                crawler=crawler, provinceName=provinceName).first()
+                crawler=crawler,
+                provinceShortName=provinceShortName).first()
         except Province.DoesNotExist:
             raise Http404
 
     @method_decorator(cache_page(TIMEOUT))
-    def get(self, request, provinceName):
-        province = self.get_object(provinceName)
+    def get(self, request, provinceShortName):
+        province = self.get_object(provinceShortName)
         serializer = ProvinceSerializer(province)
         return Response(serializer.data)