提供尽可能多的上下文；我在使用drf-spectacular构建API文档时遇到了两个问题；
使用默认配置，我甚至无法加载文档的页面，因为我有一个自定义auth后端(使用firebase_admin5.2.0)，swagger (或ReDoc)是REST的一部分，因此，必须传递一个有效的令牌来加载在文档端点中分配的页面(这在浏览器中是不可能的)。其次，也是最重要的是，我无法使用drf-spectacular配置我的自定义fireb
浏览 10提问于2022-03-18得票数 0
回答已采纳
2回答
我正在使用django==2.0中的redoc来记录一些django应用程序接口。我注意到，默认情况下，redoc会自动命名端点，如下图左侧所示。最有可能的是，我不想使用生成的名称，而是想自定义名称。来自有redoc文档经验的人，您能给点建议吗？ ?
浏览 40提问于2019-03-28得票数 1
我在为API编写文档。我也用过。它适用于常规的Docs，但不适用于Redoc。router.StaticFile("/swagger", "./api/swagger.yaml")
sh := middleware.SwaggerUI
浏览 34提问于2022-11-09得票数 0
1回答
Redoc是一个很棒的工具，但我很难理解它是如何工作的。目前，我的任务是从api-docs.io复制一些文档，以便使用redoc进行自助服务。但是，我的问题是模式不会像在api-docs站点上那样出现在侧边栏中。我不知道怎样才能让模特也在旁边展示……而且我对api文档还是个新手。您还可以查看模型是如何在here中显示的。我看了看这是否是redoc的一个特性，偶然发现了this merged PR (
浏览 20提问于2021-07-22得票数 0
在下面的代码中，无法为管理/和工资单/两个端点生成模式。path(‘SpectacularSwaggerView.as_view(url_name='schema')，/’，包含(‘payslip.urls’)路径(‘api/schema/’，SpectacularAPIView.as_view()，名称=‘’)，#可选的UI: path(‘api/schema/swagger/’，名称=‘swagger’)，路径(‘<em
浏览 6提问于2021-02-04得票数 0
1回答
Uvicorn running on ←[1mhttp://127.0.0.1:8000←[0m (Press CTRL+C to quit){"name":"my app API我在互联网上看到了一个简单的例子，在这个例子中，我在浏览器中导航到端点，但在我的例子中，项目要复杂得多，文件夹的树也很大。我在浏览器中的地址之后输入的任何内容，都会给出{"detail":"Not Found&q
浏览 6提问于2022-01-07得票数 1
回答已采纳
我用django-rest-framework编写了大量的API端点，并且不断增加和更新。如何创建和维护应该是最新的API文档？我现在的版本是
然后将此文件用作readme.io、ReDoc或其他替代方案的输入，以便向外部人员提供可视化。
浏览 2提问于2018-07-14得票数 2
视图中，我获得了在api端点下分组的所有端点，例如：
如果在v1下添加更多端点，则所有端点都位于api端点之下。我想要实现的是，将Swagger中的端点进行不同的分组，例如通过app。因此，我将使用home、jwt、api而不是api，这样在Swagger中导航就更容易了(当我添加更多的端点时，使用当前的方法，它只是显示了大量URL列表，不太适合用户使用)。我已经读到，这些组
浏览 7提问于2020-07-10得票数 11
回答已采纳
在配置Docket bean的过程中，我使用它的方法additionalModels()来添加一个我想要记录的模型。此模型未被任何端点显式使用。在检查生成的/v2/api-docs以及swagger-ui.html之后，我可以确认此模型与所有其他模型一起被正确地放置在“定义”属性下。另一方面，ReDoc似乎只呈现端点及其显式使用的模型和响应。我能以某种方式强制ReDoc呈现一个额外的类吗？例如，在API描述中以某种方式引用它？
我不
浏览 5提问于2018-07-10得票数 1
回答已采纳
试图根据文档记录API，但我得到了错误"AttributeError：'function‘object没有属性'with_ui'"，这是我在urls.py中的代码 openapi.Info( default_version='v1',
description="A samp
浏览 4提问于2020-09-05得票数 0
回答已采纳
工作的测试端点:baseurl/ds-clm-aks aks/ test OpenAPI有效的json : baseurl/ds-clm-metadata-aks/openapi.json 本地容器运行正常: localhost:4557/docs，localhost:4557/docs 理想情况下，文档应该呈现在: baseurl/ds-clm-metadata-aks/docs 但会给出以下错误： ?Redoc url :baseurl/ds-cl
浏览 30提问于2020-08-21得票数 1
是否可以像redoc页面中的swagger.io html页面那样提出请求？或者只是为了显示API的细节？
浏览 5提问于2016-11-14得票数 4
回答已采纳
我使用redoc + drf_yasg来生成使用django-rest-framwork生成的api的文档。只要我添加一个入口点，它就能很好地工作，它在文档中显示得很好。但是，我不知道如何在文档中添加在查询过程中可以提供的搜索参数。serializer = TechnicalDataSerializer(technical_data)
我在<e
浏览 27提问于2021-06-09得票数 2
我已经使用openapi和redoc生成了一个动态API模式。非常酷的解决方案我在视图集和一些函数中有很多权限(permission_classes)。您是否知道将权限包含在模式中或一般文档中的解决方案？我已经有了一个想法:在模式中的自定义描述中包含权限，但它仍然是脏的
谢谢。
浏览 0提问于2020-02-18得票数 0
我看到了Redoc文档中包含的一些代码示例，甚至测试了API文档文件中的其他openapi.json文件，以证明它可以生成它们。我不知道的是将x-code-samples放在openapiContext中以生成请求样本的位置。这就是我想在redoc里看到的。
浏览 16提问于2022-11-28得票数 0
回答已采纳
我使用swagger.json文件(由ReDoc生成)来显示ReDoc文档。我需要的：将x-logo供应商扩展添加到使用Swashbuckle (Swashbuckle.AspNetCore.SwaggerGen库)生成的swagger json中，以便ReDoc用户界面显示左上角的徽标
pub
浏览 0提问于2019-01-23得票数 3
回答已采纳
我正在实现一个具有端点的API，该端点返回对象(如公司、销售线索等)的自定义字段列表。当创建销售线索时，用户应该能够在硬编码的字段旁边输入自定义字段。如何在模块的可映射参数中动态完成此操作？
浏览 32提问于2020-09-29得票数 1
回答已采纳
在Django 1.11中，我定义了Django REST：url(r'^api/test_token$', api.test_token, name='test_token'),并生成API文档，如swagger/redoc (可用于测试API)注意事项：
在此还指出，django rest-swagger在2019年6月被否决。在Dja
浏览 29提问于2021-01-27得票数 12
回答已采纳
在Redocly中，如何在x-codeSamples标记中引用外部文件？Redocly参考指南：https://redoc.ly/docs/api-reference-docs/vendor-extensions/redoc-supported-extensions/#x-codesamples在下面的示例中，第一个案例('Example request')正确呈现。request
浏览 24提问于2021-05-01得票数 0
云服务器
ICP备案
云直播
实时音视频
即时通信 IM
腾讯云开发者
