00:00
看看命令行工具和API文档。啊,看一下命令函工具,就是订购API规,我们提供了这三个啊,比较好用的一个命令函工具,我们有的已经用了,比如使用API root,可以看我们所有的API的一个路由的情况,我们来试一下,要在我们的虚拟机里面去执行啊,在我们的项目下去执行PP。API。Are?啊,这里列举了我们所有的API的一个路由,包括它的版本号啊,比如啊是不是受保护的。好。啊,就是说是不是需要认证,你看我们这个user就需要认证对不对。好。啊,包括请求的一个频率的一个限制。啊,就说一个请求一秒,因为我们限制了一分钟。60个嘛,所以就是一次请求每秒吗。好,接下来还有什么命令呢?使用这个API开启,可以为我们的API路由生成缓存,这个一般我们在上线到这个生产环境才进行使用,本地的话我们就不去开启了啊。
01:13
好,还有一个命令就是使用API啊,这个DOS可以给我们生成API的一个文档。啊,下面有一些举例。啊,接下来我们就看一看API文档。API的文档和API的功能一样,作用文档是方了方便我们自己去查阅,而更方便别人去在使用我们的API的时候去查阅,而D提供了在API的啊CTRL里面添加注释后,通过R命令生成文档,使用这个命令,也就是我们呃在这个控制器的这个上面去加上对应的注释就可以生成。啊,对应的文档是吗。啊,这些都是我们可以使用的一些啊方式啊,包括加上这个请求的这个地址和一个请求的方式,包括加上我们的版本啊,以及我们请求的需要的一些参数,好,我们直接看。
02:08
最后一个啊,就是比较完整的一个。啊,比如这里啊,可以加上一些啊,相应的一些状态啊,响应的这个2002442啊多种状态,比如请求的版本,请求的方式啊,包括我们的请求的参数啊,这里我们直接拿这个来作为示例啊。找到控制器。好。这个啊。这个我把它删掉吧。不要让它影响我们的测试。放到哪里呢?你随便我们随便放一个控制器吧,比如放到这个。User里面。啊,放到这个这个吧。啊音里面啊,随便去放一个啊。就是以控制器注释的形式去写我们的API文档啊,一个是我们的文档的这个API的一个作用,然后要传,就是说API的一个描述。
03:07
以及请求的方式啊,和请求的一个地址,这里是请求这个音啊。API啊。好版本以及我们就是要给我们传什么参数,我们会生成什么样的响应啊,生成两个响应,一个这个啊三二的一个响应,一个二零的一个响应,好接下来呢,只需要啊执行这个命令。PPAPI冒号啊,DOS就可以生成API的文档,可以看一下它生成的文档啊,在这里它会输出到这个标准的,标准输出里面,就是我们终端里面。然后我们的。这个API的作用,然后请求的方式,请求的地址。啊,我们的描述,API的描述,包括请求的这个参数对吧,请求的这个响应的这个状态,响应的这个第二个状态都有啊,包括响应的参数。
04:00
这样的话啊,我们就不用再去写文档了,可以直接把这个它输出的这个结果去输出到一个文件里面,就可以作为我们的片的一个文档。就什么?来看一下怎么输出到文件,找找手册啊,在后面用。啊,输出到文件。嗯。我看看他,呃,手册在哪里啊。啊,这里没有说啊,这里只是介绍我们文档的这个规则,写文档规则应该是在命令行里面。嗯,找到。这个啊,输出到文件。看到了吗?我们来复制一下,其实呃,这个name我们不用取啊,Name我们不写的话,它会会默认使用我们英文里面配置的那个那个name啊,包括这个版本号我们也可以不指定,它会默认去使用这个。啊,就是说我们V这个版本里面的这个。这个路由啊。
05:00
好,其实我们只要一个这个啊output-Fi去生成指定的,生成到指定的一个文件里面就可以啊。来。接着我们来执行一下这个命令啊,粘贴一下。然后空格直接写这个刚刚out。后面跟我们生成的文件的一个位置,我们用绝对路径在啊home目录下we grant里面有一个code目录,接着是我们的项目啊效果API我们生存,我们项目里面叫什么呢?Don t叫MD啊,它这个是MD的语法,所以我们用啊叫MD命名来回车。Successful,接下来去我们的项目目录,我们检查一看,就多了一个这么一个文档文件是吧?啊,在我们。P里面打开是可以直接去啊解析这个啊,马可当的这个语法的可以看到。对吧。
06:04
但是呃,我们如果去这么去写的话,就是它会把所有的这个API的写在一起,不方便我们去查阅,所以我们在写API的时候呢,会使用一个在线的一个啊API文档。工具,当然线上有很多这样的一个写文档的工具啊,我们选了一个比较简单的啊。就这个。我们会在这里面去写我们的文档示例啊。这里有他提供的一些接口的一些事例。我们把我们的API的文档写到这里面,嗯。当然也可以。啊,有这种方式是可以通过这个注释去生成这个啊文档,大家要知道这个。
我来说两句