代码之家 › 专栏 › 技术社区 › Kinglish

如何制作apidoc。需要json参数?

api-doc json

Kinglish · 技术社区 · 8 年前

非常简单,但我找不到关于如何将参数标记为的文档 必修的 当我标记文档以生成api文档时(使用包@: http://apidocjs.com )

// My APIDOC markup in my PHP doc

 * @apiParam {String} [type] comma delimited list of any or all of: contests, deals, coupons

... 生成以下html:

我想要 optional 如图所示成为 required . 它的标记是什么?

1 回复 | 直到 8 年前

Kinglish 8 年前

找到了。事实证明,您只需删除变量周围的[]括号

 * @apiParam {String} required_variable comma delimited list of any or all of: contests, deals, coupons

推荐文章

Sweepy Dodo · JSON lite的格式化

1 年前

SebMa · 为什么我用mikefarah/yq得到两倍的JSON输出?

1 年前

Dione Saturn · JSON、fetch、HTML中的javascript和未定义或空字符串[重复]

1 年前

user24242514 · 将嵌套查询字符串请求转换为字典

1 年前

Shane Harley · 通过这些JSON元素进行映射

1 年前

Milenko Markovic · 如何使用Python读取JSON?操作系统错误:[Errno 36]文件名太长:

1 年前

Shane Harley · 将HTML作为JSON字符串的一部分?

1 年前

user6631314 · 使用PHP从api响应中提取视频数据[复制]

1 年前

Matt Miles · 如何将嵌套的JSON转换为数据帧?

1 年前

ololo · 不支持目录导入

1 年前