apidoc文档使用方法

Posted

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了apidoc文档使用方法相关的知识,希望对你有一定的参考价值。

参考技术A 0、本项目以laravel框架为例;
1、安装: https://apidocjs.com (安装完成后所有位置都能执行相关命令);
2、项目根目录创建apidoc.json文件;
3、控制器中编写对应的文档信息;
4、根目录执行命令生成文档;

1、安装根据官网教程即可;

2、项目根目录创建对应的json文件;内容如下

3、控制器中编写对应的文档信息;(注释部“/**/”分为文档生成的内容)

4、根目录执行命令生成文档;

app/Http/Controllers/Admin ---需要生成文档的控制器地址
public/apidoc/admin ---生成的文档保存位置

以上是关于apidoc文档使用方法的主要内容,如果未能解决你的问题,请参考以下文章

apidoc文档使用方法

flask + apidoc 生成接口文档(附加一个坑)

浅谈apidoc的使用

laravel中使用apidoc

使用apidocJs快速生成在线文档

apiDoc构建源代码注释的接口文档