# napi

**Repository Path**: monksoul/napi

## Basic Information

- **Project Name**: napi
- **Description**: No description available
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2019-10-25
- **Last Updated**: 2021-08-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# NAPI 

> NAPI 脚手架可以快速生成 NodeJS 版本的 Swagger 文档

## 项目信息

- 项目作者：MonkSoul
- 开源协议：MIT License
- 当前版本：2019.10.25 `v1.0.0`
- Github ：[https://github.com/MonkSoul/napi](https://github.com/MonkSoul/napi)

## 项目结构

初始化目录结构

```
NAPI 项目目录
├─app                            源码目录
│  ├─contract                    接口参数类型定义目录
│  ├─controller                  控制器目录
│  │  ├─home.js                  默认控制器（勿删）
│  ├─model                       数据库实体定义目录
│  ├─public                      静态资源目录
│  ├─service                     业务逻辑目录
│  ├─util                        工具目录
│  ├─router.js                   路由配置
├─config                         配置目录
│  ├─core                        核心配置目录
│  │  ├─database.config.js       数据库配置
│  │  ├─swagger.config.js        接口文档信息配置
│  │  ├─table.config.js          数据库表配置
│  ├─config.default.js           默认配置文件
│  ├─plugin.js                   第三方插件配置文件
├─logs                           日志保存目录
├─.gitignore                     项目文件忽略配置文件
├─package.json                   包配置文件
```

## 更新记录

```
============ 2019.10.25 V1.0.0 ============

- [新增] 完成脚手架开发

```

## 使用教程

整理中....