# vscode-extension-torna-api-visitor

**Repository Path**: gimholg/vscode-extension-torna-api-visitor

## Basic Information

- **Project Name**: vscode-extension-torna-api-visitor
- **Description**: 用于Torna接口文档系统的接口代码文件生成器。
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2022-12-17
- **Last Updated**: 2025-08-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: torna, VSCode, extension

## README

# torna api visitor README

torna-api-visitor 通过torna的接口文档与代码模板文件生成接口代码文件。

what is [Torna](https://www.torna.cn/)

## Installation

- 下载 <https://gitee.com/gimholg/vscode-extension-torna-api-visitor/releases>
- 安装 ![how to install](doc/how_to_install.gif)

## Features

TODO

## Extension Settings

This extension contributes the following settings:

- `torna-api-visitor.output`: Output directory path relative to workspace path
- `torna-api-visitor.template`: Typescript template file for api file genarating.

## Known Issues

...

## Release Notes

### 1.0.0

Initial release

---

## Following extension guidelines

TODO

## Working with Markdown

TODO

## api模板文件

api模板文件本身应该就是合法的ts代码，其中一些特殊的字符串将被替换。

### 插入文件头

以下注释将被替换成本插件生成文件的注释头

``` javascript
/*tav* $$_FILE_HEADER_ZONE *tav*/
```

生成注释头示例如下

``` javascript
//// Generated by Torna Api Visitor 2.5.3 DO NOT EDIT IT DIRECTLY!
//// @name         查询列表
//// @author       author
//// @see          https://doc.x.net/#/view/docId
//// 
//// @projectId    projectId
//// @moduleId     moduleId
//// @docId        docId
//// @docUrl       https://doc.x.net/
//// @baseUrl      
//// @apiUrl       /api/demo
//// @envs         
////               [开发环境] https://b-api-dev.x.net
////               [生产环境] https://b-api.x.net
//// @httpMethod   POST
//// @description  查询列表
//// @createTime   2023-10-24 18:44:11
//// @lastModified 2024-03-20 14:29:30 
```

### 指定引入方式

在使用`TAV: Import Api`或`TAV: Use Api`时，会根据指定的引入方式，在你的代码中插入import api文件的代码。

默认: `import * as $$_FILE_NAME from "$$_RELATIVE_PATH"`

``` javascript
/*tav* howToImport : import { $$_FILE_NAME } from "$$_RELATIVE_PATH" *tav*/ 
```

- TODO 这里需要更多说明

### 设置Header参数类名

默认: HeaderParams

你也可以加入如下注释，设置自定义的名称

``` javascript
/*tav* headerTypeName : MyHeaderParams *tav*/ 
```

### 设置Query参数类名

默认: QueryParams

你也可以加入如下注释，设置自定义的名称

``` javascript
/*tav* queryTypeName : MyQueryParams *tav*/
```

### 设置Body参数类名

默认: BodyParams

你也可以加入如下注释，设置自定义的名称

``` javascript
/*tav* bodyTypeName : MyBodyParams *tav*/
```

### 设置响应对象类名

默认: Response

你也可以加入如下注释，设置自定义的名称

``` javascript
/*tav* respTypeName : MyResponse *tav*/
```

### 设置Header变量名

默认: header

你也可以加入如下注释，设置自定义的名称

``` javascript
/*tav* headerValName : my_header *tav*/
```

### 设置Query参数变量名

默认: params

你也可以加入如下注释，设置自定义的名称

``` javascript
/*tav* queryValName : my_params *tav*/
```

### 设置Body参数变量名

默认: body

你也可以加入如下注释，设置自定义的名称

``` javascript
/*tav* bodyValName : my_body *tav*/ 
```

### 指定地址参数是否允许使用字符串类型

默认: 允许

如不允许，则加入如下一行注释

``` javascript
/*tav* queryAllowString : false *tav*/ 
```

### 指定是否生成interface

默认: 是

如果需要生成type，则加入如下一行注释

``` javascript
/*tav* toInterface : false *tav*/ 
```

## TODO

import/use时不再重新生成代码文件。
支持选择不同模板文件。
支持自动刷新生成的代码文件。