文件名称:apiDoc:RESTful Web API 文档生成器-开源
文件大小:600KB
文件格式:ZIP
更新时间:2024-08-07 08:38:00
开源软件
apiDoc 根据源代码中的 API 注释创建文档。 apiDoc 使您能够将版本号附加到 API,以便您可以轻松跟踪版本之间的更改。 创建目录 myapp/ 中所有文件的 apiDoc,使用目录 mytemplate/ 中的模板并将所有输出放入目录 apidoc/。 没有任何参数,apiDoc 从当前目录(包括子目录)中的所有 .cs .dart .erl .go .java .js .php .py .rb .ts 文件生成文档并将输出写入 ./doc/。 apiDoc 包含一个默认模板,它使用把手、Bootstrap、RequireJS 和 jQuery 来将生成的 api_data.js 和 api_project.js 输出为 html 页面。 默认情况下,生成的 apiDoc 使用支持版本控制的复杂模板来查看 API 的不同版本,并比较以查看 API 的两个版本之间的更改。 您可以创建自己的模板并使用 apiDoc 生成的文件。