如何编写api文档


文档内容:

此篇文档的内容是如何在api项目上编写文档。
如需要更新外网api,请参见此文档:api项目更新文档

开发环境搭建和项目挂载:

1、首先需要进行项目的挂载,点击查看。
2、安装iis服务器,点击查看。
3、项目挂载IIS,点击查看。。
4、配置本机DNS,点击查看

Api文档的编写方式

1、首先,我们可以查看示例文件,点击查看
2、在指定的文件或者目录下创建好aspx文件。
3、复制示例文件的代码,粘贴于刚创建的文件。
4、仔细查看代码注释部分,修改左侧导航栏、头部导航栏控件地址。
5、在样式名为book-body的元素中进行标题编写
6、在样式名为book-content的元素中进行内容的编写
7、在工作人员处进行作者信息的填写。
                

工作人员

 
                    
作者:蔡旭升
信息录入:蔡旭升