api-doc相关内容

有关Python模块/包名称的Sphinx apidoc部分标题

当我运行sphinx-apidoc,然后运行make html时,它生成的文档页面在目录(TOC)中的每个模块/包名称的末尾都有“子程序包”和“子模块”部分以及“模块”和“包”。如何在不编辑Sphinx源代码的情况下阻止编写这些额外的标题? 以下是我要制作的示例文档页面(请注意TOC): http://selenium.googlecode.com/svn/trunk/docs/api ..
发布时间:2022-04-20 23:50:12 前端开发

Slate vs Swagger - 哪个更好,哪个有更多选择?

我必须记录我的 API.我必须使用其中任何一个 Slate 或 Swagger.我想知道哪个有更多的选择,利弊,哪个更好. 解决方案 Swagger 和 Slate 有两个不同的用途.Swagger 是一种描述 RESTful API 的标准化方式的尝试(例如,类似于 ApiBlueprint) Swagger 是一种基于 JSON 的 API 定义格式,允许描述 REST API. ..
发布时间:2022-01-22 18:12:34 其他开发

Symfony - 注释从未被导入

我正在使用 Symfony 框架并打算将自动文档引擎添加到我项目的 RESTful api. 经过一番搜索,我找到了 apidoc 引擎(http://apidocjs.com/).它的工作原理非常简单:您必须为 RESTful api 的每个控制器添加一些注释,并会生成文档. 注解的例子是: /*** @Route("/api/dictionary_list/{userId}/{s ..
发布时间:2021-11-10 22:47:25 PHP

如何使用 openapi-generator 生成 API 文档?

我是 OpenAPI 3.0.0 的新手. 我已经使用 openapi-generator 成功创建了一个 java 客户端库. 但是 OpenAPI Generator 允许生成 API 客户端库(SDK 生成)、服务器存根、文档.所以我想知道是否有任何命令或步骤可用于生成 HTML 文档以及自定义文档模板. 解决方案 老问题,但对于那些仍然遇到它的人.OpenApi Gen ..
发布时间:2021-06-12 19:28:59 其他开发

Slate vs Swagger-哪个更好,哪个有更多选择?

我必须记录我的API。我必须使用其中任何一个 Slate 或 Swagger 。我想知道哪个有更多的选择,利弊,哪个更好。 解决方案 Swagger和Slate提供两种不同的选择目的。 Swagger是尝试以一种描述RESTful API的标准化方式(例如,类似于 ApiBlueprint ) Swagger是基于JSON的API定义格式,用于描述REST API。 〜 API ..
发布时间:2020-10-25 05:55:41 其他开发

Swagger HashMap属性类型

在模型部分中是否可以定义HashMap或通用对象类型? 我有一个返回产品的REST服务,这些产品可以有不同的选择. options属性基本上是一个HashMap,其中id是选项名称,其值是选项值. 解决方案 是的. 在OpenAPI(fka.Swagger)2.0和3.0中,哈希图始终是映射: 键始终是字符串,不需要定义. 所需的值类型是 ..
发布时间:2020-09-05 19:01:16 其他开发

Symfony-注释从未导入

我正在使用Symfony框架,并打算将自动文档引擎添加到我项目的RESTful api中. 经过一番搜索,我发现apidoc引擎( http://apidocjs.com/).它的工作非常简单:您必须为RESTful api的每个控制器添加一些批注,然后会生成文档. 注释的示例是: /** * @Route("/api/dictionary_list/{userId}/{ses ..
发布时间:2020-09-02 00:33:37 PHP

Apidocjs文档创建问题,警告:插件参数解析没有发现和失踪逗号问题

我试着用apidocjs创建API文档和在编译的项目使用的项目文件夹中创建apidoc.json我apidoc了问题。 code位置: 〜$ apidoc -i ./ -o apidoc / 和结果警告:插件解析器参数''未找到。 错误:错误:无法读取:apidoc.json,请检查格式(例如缺少逗号)。 请人帮我解决这个问题。 相关apidocjs.com 标签 解决方案 删除 ..
发布时间:2016-05-23 22:25:39 其他开发