python-3.x - 如何将 coreapi 客户端与 django rest 框架一起使用?
问题描述
我已将 django rest 框架 3.10 版集成到现有的 django 2.2 项目中,将 api root 放在/api
.
现在我正在尝试使用 coreapi cli 客户端将一些文档上传到服务器。
$ coreapi get http://localhost:8000/openapi
<DownloadedFile '/root/.coreapi/downloads/openapi (4)', open 'rb'>
$ coreapi get http://localhost:8000/api
{
"invoices": "http://localhost:8000/api/invoices/"
}
$ coreapi action invoices list
Index ['invoices']['list'] did not reference a link. Key 'invoices' was not found.
/openapi
是根据请求生成模式并返回的端点
openapi: 3.0.2
info:
title: Orka
version: TODO
description: API for orka project
paths:
/invoices/:
get:
operationId: ListInvoices
parameters: []
responses:
'200':
content:
application/json:
schema:
required:
- file_name
- original_file_name
properties:
file_name:
type: string
original_file_name:
type: string
maxLength: 80
upload_date:
type: string
format: date-time
readOnly: true
data:
type: object
nullable: true
confidence:
type: number
user_verified:
type: boolean
/invoices/{id}/:
get:
operationId: retrieveInvoice
parameters:
- name: id
in: path
required: true
description: A unique integer value identifying this Invoice.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
required:
- file_name
- original_file_name
properties:
file_name:
type: string
original_file_name:
type: string
maxLength: 80
upload_date:
type: string
format: date-time
readOnly: true
data:
type: object
nullable: true
confidence:
type: number
user_verified:
type: boolean
没有任何复杂的发票路径存在(即使它应该是/api/invoices
)。
我已经成功地让 coreapi 与外部 api 一起工作,所以这似乎是我如何配置我的 url 和/或视图的问题。
他们俩都很简单。
# urls.py
from rest_framework import routers
from . import views
router = routers.DefaultRouter()
router.register(r'invoices', views.InvoiceViewSet)
urlpatterns = [
path('api/', include(router.urls)),
]
# views.py
# ... imports ...
class InvoiceSerializer(serializers.HyperlinkedModelSerializer):
"""Defines API representation of invoices"""
class Meta: # pylint:disable=too-few-public-methods, missing-docstring
model = Invoice
fields = (
'file_name',
'original_file_name',
'upload_date',
'data',
'confidence',
'user_verified',
)
class InvoiceViewSet(viewsets.ModelViewSet):
"""Defines api views for invoices"""
# default permissions are set in settings.py
parser_classes = (JSONParser, XMLParser, FormParser, MultiPartParser)
queryset = Invoice.objects.all()
serializer_class = InvoiceSerializer
@action(methods=['post'], detail=True)
def upload_with_ground_truth_file(self, request, pk):
pass
似乎我遗漏了一些明显的东西。我需要配置什么才能使用 coreapi 客户端来使用我的 api?
解决方案
我遇到了同样的错误——python 3.8.5、Django 3.1、DRF 3.12.1。对我来说,相似之处在于coreapi
返回 aDownloadedFile
而不是 a Document
,这似乎在coreapi
收到它不期望的内容类型时发生。
对我来说,解决方案是:
pip install openapi-codec
(如果你还没有安装它)coreapi get http://localhost:8000/openapi?format=openapi-json --format=openapi
您将知道它成功了,因为您不会看到任何提及DownloadedFile
,而是可用标签/操作的摘要。
不知道为什么强制格式应该是必要的。
推荐阅读
- android - A/位图:错误,无法在此处访问无效/释放的位图!A/brutx.mymodeap: runtime.cc:655] 运行时中止
- python-3.x - 交互式 Python 示例重定向 URL?
- android - android可以为MD5抛出NoSuchAlgorithmException吗
- python - 我如何从 python 数据集中的文本文件中读取数据并在其上应用矩阵
- python - sybase 到 sql 服务使用炼金术
- matlab - 在 colab 中使用 octave 运行 .cu 文件
- java - “返回;” vs“空方法体”
- mysql - 使用 MySql 的端点测试 Node Express API
- bash - Bash - 以数字格式转换意大利日期
- kubernetes - 如何重新创建 Kubernetes 持久卷?