JSPM – nest-canddy@0.0.5

Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (nest-canddy) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

# nest-canddy

`nest-canddy` 是一个无侵入代码的CLI工具，它可以快速生成前端可用的TypeScript SDK代码，用于发起http请求。同时，它还提供一个可视化的web ui界面，用于简单的展示项目模块结构。

## 功能

- 快速生成前端用于发起RESTful请求的TypeScript SDK代码
- 提供Web UI可视化界面

## 安装

你可以通过npm或yarn安装`nest-canddy`：

```bash
yarn add -g nest-canddy
//or
npm install -g nest-canddy
```
### 作为服务端

如果你当前的角色是使用nestjs框架的服务器开发人员：

1. 在nestjs的项目根目录下新增`nestcanddy.config.js`
```javascript
module.exports = {
    server:{
        port: 13270,//作为提供SDK拉取服务的端口号
        outputPath:'./output',//生成SDK的保存目录
    },
}
```
2.接下来，你可以生成前端Typescript SDK代码。
```bash
nests generate
//or
nests g
```
<video width="320" height="240" controls>
<source src="https://caidan-1318352346.cos.ap-guangzhou.myqcloud.com/upload/demo/nest-canddy-demo-1.mp4" type="video/mp4">
你的浏览器不支持视频标签。
</video>
3.你也可以使用Web UI来查看和生成生成前端Typescript SDK代码。
```bash
nests server
//or
nests s
```
<video width="320" height="240" controls>
<source src="https://caidan-1318352346.cos.ap-guangzhou.myqcloud.com/upload/demo/nest-canddy-demo-1.mp4" type="video/mp4">
你的浏览器不支持视频标签。
</video>

### 作为客户端

如果你当前的角色是使用Typescript开发任何项目的前端开发人员：

1. 在nestjs的项目根目录下新增`nestcanddy.config.js`
```javascript
module.exports = {
    client:{
        host: 'localhost:13270',//后端提供的SDK服务地址
        outputPath:'./output',//SDK输出到当前项目的相对路径
        httpAdapterPath:'axios',//发起http请求的适配器引用路径
        httpAdapterName:'axios'//发起http请求的适配器引用名称
    }
}
```
2.接下来，你可以拉取前端Typescript SDK代码。
```bash
nestc get
//or
nestc g
```