腾讯云
开发者社区
文档
建议反馈
控制台
首页
学习
活动
专区
工具
TVP
最新优惠活动
文章/答案/技术大牛
搜索
搜索
关闭
发布
登录/注册
精选内容/技术社群/优惠产品,
尽在小程序
立即前往
文章
问答
(9999+)
视频
沙龙
1
回答
如何从基于TypeScript的Express应用程序中
生成
swagger
文档
?
node.js
、
typescript
、
express
、
swagger
我正在使用TypeScript,它在dist下
生成
.
js
文件,dist没有添加任何
API
注释
。指向apis: ['../dist/*.
js
']或指向Route.ts将
生成
API
的详细信息。description: This should return okthis.router.get("/", (req: Request, res: Response) => this.<e
浏览 1
提问于2019-08-13
得票数 14
1
回答
从代码中的
注释
生成
swagger.json文件
javascript
、
swagger
、
openapi
我正在为用node.
js
编写的
API
创建
文档
。 我手工创建了一个swagger.json文件,并将其输入到swagger-ui前端,以便
生成
漂亮的
API
文档
。但是,我想要做的是以类似于JSDoc的方式从代码中
生成
API
文档
--只需用
注释
标记代码,然后运行一个命令,直接从代码创建
文档
(在本例中是swagger.json文件)。
浏览 1
提问于2022-11-09
得票数 0
回答已采纳
2
回答
通过代码
注释
生成
API
文档
node.js
、
rest
、
documentation
、
apiblueprint
我正在使用aglio
生成
我的
API
文档
。我目前正在根据规范编写原始标记。我想知道是否有一种方法可以通过代码中的
注释
直接
生成
减价。有人知道怎么做吗?
浏览 4
提问于2014-05-14
得票数 4
回答已采纳
1
回答
从Restlet
注释
生成
Restlet
文档
restlet
、
restlet-2.0
Restlet网络服务
API
是使用RESTful实现的。我需要为这些文件
生成
API
文档
。我不是从一个单独的
文档
开始,而是评估是否可以从源代码
注释
本身
生成
这个
文档
。 是否有从Restlet
注释
生成
API
文档
的工具(或者社区使用过任何工具)?是否有人将R
浏览 3
提问于2012-11-21
得票数 2
回答已采纳
2
回答
如何用JSDoc记录组件公共变量?
salesforce
、
jsdoc
、
code-documentation
、
lwc
、
salesforce-development
* */ somePublicVarName = false; 如果我将其转换为函数或公共getter/在
文档
中,我可以使用配置文件,但我不知道这是否是它的用例。我还试图添加@public JSDoc属性跳转来解决这个问题,但没有帮助。
浏览 12
提问于2022-02-28
得票数 2
回答已采纳
1
回答
Python,Swagger,从
注释
生成
API
文档
python
、
flask
、
swagger
、
documentation-generation
我有一个现有的书面应用程序,
API
是以下列方式编写的:def hello():我想从这类
API
生成
Swagger
文档
到目前为止,我尝试了很少的选项,但大多数选项都是从特定方法的docstring中的yml文件或yml字符串
生成
文档
。 我想使用基于
注释
的方法。
浏览 2
提问于2017-05-04
得票数 4
2
回答
什么是
生成
简单
API
文档
的红宝石?
ruby-on-rails
、
ruby
、
rest
、
api
、
ruby-on-rails-4
是否有任何简单的红宝石能够: 显示自定义
注释
。如果我想详细解释
API
端点。因此,我不需要只
浏览 5
提问于2017-01-26
得票数 0
回答已采纳
1
回答
为什么ngdocs会
生成
0个文件?
javascript
、
gruntjs
、
jsdoc
但是,当我尝试
生成
文档
时,它无法识别任何
注释
。为什么?!帮助!Gruntfile.
js
ngdocs: {
api
:{
浏览 0
提问于2014-04-29
得票数 3
2
回答
在哪里可以找到Ember 0.9.8的
文档
?
ember.js
但是,我仍然需要参考旧的
文档
,而且这个网站似乎只能追溯到1.10。
浏览 0
提问于2018-07-24
得票数 0
回答已采纳
1
回答
openapi 3中有自定义属性吗?
swagger
、
openapi
、
swagger-php
我们有php-swagger,它以开放的
api
3.0格式
生成
开发人员
文档
。结果是,您需要在代码中以某种方式标记
注释
,这些
注释
是其他
文档
的
注释
。并创建一个新的json文件。问题是,我不知道如何在php代码中在
注释
级别标记路由,
浏览 1
提问于2022-07-04
得票数 0
3
回答
如何使用Springdoc从OpenAPI
文档
中隐藏端点
java
、
spring-boot
、
openapi
、
springdoc
Springdoc自动为所有处理程序方法
生成
API
文档
。即使没有OpenAPI
注释
。 如何从
API
文档
中隐藏端点?
浏览 2
提问于2020-05-30
得票数 10
回答已采纳
4
回答
具有轻量级标记的Javascript
API
文档
框架
javascript
、
markdown
、
python-sphinx
、
restructuredtext
、
jsdoc
我正在寻找一个Javascript
API
文档
框架,具有类似于JSDoc的功能,但会在代码
注释
(而不是html)中使用易于键入的重构文本或标记。 额外好处:可以很好地与Sphinx集成。但是,我不想维护单独的
文档
,而是从
注释
生成
API
文档
。
浏览 0
提问于2011-08-12
得票数 5
回答已采纳
1
回答
拉威尔、流星、下划线和AngularJS是如何
生成
它们的
API
文档
的?
angularjs
、
laravel
、
meteor
、
underscore.js
下划线对带
注释
的源代码使用docco。但是
API
文档
呢?这些项目如何
生成
各自的
API
文档
?
浏览 1
提问于2014-05-09
得票数 1
6
回答
如何轻松地为
文档
化的JavaScript函数创建友好的标记?
javascript
、
github
、
markdown
、
jsdoc
我希望能够在JSDoc源代码中的任何地方(甚至嵌套几层函数,在一个模块甚至匿名函数中)接受这样的JavaScript
注释
: * Used to do some important thing或者,如果它是一个匿名函数或一个私有函数(由于某种原因应该出现在公共
文档
中,这有意义吗?),使用其他约定来表示它。另外,如果它能够处理大量的源文件并
生成
一个
文档
作为输出,或者根据配置来
生成
一组链接的
文档
,那就更好了。我尝试过“exportand@name”,但仍然很难让它以我想要
浏览 4
提问于2013-03-28
得票数 69
1
回答
从模式
生成
静态
API
文档
?
node.js
、
express
、
swagger
、
swagger-ui
、
koa
我有Koa/Express应用程序,并且希望基于对不同
API
路由的
注释
生成
一个静态
文档
。还有其他操作系统项目提供这种功能吗?
浏览 5
提问于2016-05-03
得票数 1
回答已采纳
2
回答
阐明Spring annotations
文档
spring
、
maven
、
documentation
、
enunciate
我在一个maven项目中使用Enunciate来
生成
REST
API
文档
。工件安全性
生成
Web
API
文档
,但是它忽略了Spring注解,比如:@Secured (来自maven-enunciate-plugin -security) 我尝试使用具有spring支持maven-enunciate-spring-plugin的maven工件
生成
文档
,但它甚至不
生成
Web
API
文档
。有没有办法配置、表
浏览 2
提问于2013-07-03
得票数 3
回答已采纳
1
回答
@remove在Android框架中的javadoc中意味着什么?
java
、
android
、
annotations
、
javadoc
我一直在检查android中的ContextWrapper.java,并注意到@remove在javadoc中
注释
了一些方法。
浏览 5
提问于2017-09-19
得票数 2
回答已采纳
1
回答
从JSDoc
生成
Swagger YAML?
javascript
、
yaml
、
swagger
、
jsdoc
我有一个完整的JSDoc
文档
的大型
JS
,我正在构建一个基于swagger的REST服务,以使该
API
在网络上可用。我手动构建了YAML swagger规范的初始版本,但问题是它很快就与
JS
API
失去了同步,因为它仍在不断发展,特别是在涉及的对象的属性方面。我想要做的是直接从JSDoc
注释
中自动
生成
swagger YAML,至少是其中的数据定义部分。有没有什么工具可以帮我实现自动化?
浏览 1
提问于2015-09-24
得票数 9
1
回答
生成
swagger json文件而不运行nest服务器
swagger
、
nestjs
、
documentation
有没有人知道有一种方法(官方的或第三方的工具)可以在不需要nest
js
服务器运行的情况下
生成
挥霍无度的json文件?我有一个带有控制器路由的nest
js
应用程序,还有一个带有@nest/swagger装饰器的DTO
注释
文档
。我知道我可以通过启动服务器和访问/
api
-json来获得swagger json文件,但是我需要能够
生成
这个文件,而不必先启动服务器。
浏览 3
提问于2022-07-04
得票数 1
1
回答
如何根据
注释
从php symfony控制器
生成
文档
?
php
、
symfony
、
documentation
、
annotations
、
generator
我目前有一个为REST服务的控制器,我正在寻找一种基于
注释
从
API
控制器
生成
文档
的懒散方式。= "this allow user to do some stuff"@parameters {"foo","bar"}更清楚的是,我不想为我的php
生成
o
浏览 4
提问于2012-09-19
得票数 3
点击加载更多
扫码
添加站长 进交流群
领取专属
10元无门槛券
手把手带您无忧上云
相关
资讯
Web API 文档生成工具 apidoc
Swagger 生成 PHP API 接口文档详细步骤
AspnetCore 2.0 自动API文档生成组件,支持protobuffer
中年大叔学编程-Gin-Swagger生成API接口文档
关于深度学习框架Hamaa与Python API文档生成工具Sophon
热门
标签
更多标签
云服务器
即时通信 IM
ICP备案
对象存储
实时音视频
活动推荐
运营活动
广告
关闭
领券