# apidocDemo

**Repository Path**: baoyinYang/apidoc-demo

## Basic Information

- **Project Name**: apidocDemo
- **Description**: apidoc可以用来嵌入到service端，通过写注释来进行编写api文档。本项目是apidoc在nodejs环境中的一些简单运用及总结
- **Primary Language**: JavaScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-07-21
- **Last Updated**: 2021-11-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Nodejs, JavaScript

## README

## apidocDemo

`本项目是对apidoc使用的一个简单练习，更多的细节还有待去探索`

## 依赖安装

`首先需要拉取代码到本地，进入根目录，然后安装依赖`

`npm i` 或者 `yarn`

## 项目启动

`npm start` `启动一个express服务来访问生成的apidoc文件`

## 对注释进行编译生成文档

`npm run build`

## 访问文档地址

`http://localhost:3000/apidoc`

## 使用总结在以下文档中

[使用总结](summary.md)