<commit_before>NEI平台目前支持Swagger和NEI自定义的开放标准来批量导入接口。

## Swagger格式导入

Swagger格式目前支持yaml格式的文件导入。 暂时*还不(马上就要)支持json格式*的Swagger接口导入。
在导入Swagger接口前， 如果不是类似于Swagger服务自动生成而是自己手写(或修改)的, 请先到[Swagger editor](https://swagger.io/swagger-editor/)中检查该规范，确保没有错误。目前导入功能的错误提示还比较弱，如果浏览器的console日志不能定位到问题，猪场同事请联系NEI团队，其他用户欢迎直接发邮件给我，邮件地址为: <EMAIL>.


## NEI自定义标准批量导入接口

如果你的项目并不是使用swagger这类标准来定义接口， 此时要批量导入接口和数据类型定义，除了转换为Swagger标准(如果你熟悉它的话)，你也可以直接生成我们NEI的数据格式来实现该功能。下面将详细介绍该格式。

说明:

1. 下文所有的忽略该字段表示， 你可以不要这个字段，系统已经帮你设置好默认值

### 格式

#### 最外层数据

```text
{
  "datatypes": Array<NEIDatatype>,
  "interfaces": Array<NEIInterface>
}
```

这里以及下文均使用了TypeScript定义, 即":"的右边是该值的类型定义。比如说上面的"datatypes"， 他是一个NEIDatatype类型的数组。

你最终是要导出一个类似这样的json。
下面对各个类进行定义。

#### NEIDatatype 类

```TypeScript
export class Datatype{
    name: string;
    description: string;
    format: DatatypeFormatEnum;
    params: Array<Parameter>;
    tag: string;
    type: DatatypeTypeEnum;<commit_msg>Update NEI导入接口列表支持的数据格式.md<commit_after>NEI平台目前支持Swagger和NEI自定义的开放标准来批量导入接口。

## Swagger格式导入

Swagger格式目前支持yaml格式的文件导入。 暂时*还不(马上就要)支持json格式*的Swagger接口导入。
在导入Swagger接口前， 如果不是类似于Swagger服务自动生成而是自己手写(或修改)的, 请先到[Swagger editor](https://swagger.io/swagger-editor/)中检查该规范，确保没有错误。目前导入功能的错误提示还比较弱，如果浏览器的console日志不能定位到问题，猪场同事请联系NEI团队，其他用户欢迎直接发邮件给我，邮件地址为: <EMAIL>.


## NEI自定义标准批量导入接口

如果你的项目并不是使用swagger这类标准来定义接口， 此时要批量导入接口和数据类型定义，除了转换为Swagger标准(如果你熟悉它的话)，你也可以直接生成我们NEI的数据格式来实现该功能。下面将详细介绍该格式。

说明:

1. 下文所有的忽略该字段表示， 你可以不要这个字段，系统已经帮你设置好默认值

### 格式

#### 最外层数据

```text
{
  "datatypes": Array<NEIDatatype>,
  "interfaces": Array<NEIInterface>
}
```

这里以及下文均使用了TypeScript定义, 即":"的右边是该值的类型定义。比如说上面的"datatypes"， 他是一个[NEIDatatype](#NEIDatatype)类型的数组, interfaces是一个[NEIInterface](#NEIInterface)类型的数组

你最终是要导出一个类似这样的json。
下面对各个类进行定义。

#### NEIDatatype 类

```TypeScript
export class Datatype{
    name: string;
    description: string;
    format: DatatypeFormatEnum;
    params: Array<Parameter>;
    tag: string;
    type: DatatypeTypeEnum;
{'fraction_non_alphanumeric': 0.11630269172168614, 'fraction_numerical': 0.001015744032503809, 'mean_word_length': 8.380952380952381, 'pattern_counts': {'":': 6, '<': 11, '<?xml version=': 0, '>': 11, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6195586', 'n_tokens_mistral': 1254, 'n_tokens_neox': 1400, 'n_words': 93}