# openapi-client-template

**Repository Path**: bjf-fhe/openapi-client-template

## Basic Information

- **Project Name**: openapi-client-template
- **Description**: 百家饭隐私计算平台，OpenAPI调用客户端生成工具所使用的各语言模板

目前进展：Javascript进展中
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://rongapi.cn
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2022-06-15
- **Last Updated**: 2023-02-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 百家饭OpenAPI客户端生成模板

本仓库提供百家饭OpenAPI生成器使用的各语言模板，目前计划开展Javascript、Golang、Java语言的生成工作，有其他需要可以直接通过项目issues发起。

目前主要考虑针对Swagger或其他兼容OpenAPI的API后台生成对应的客户端代码。希望达到以下目的：

* 自动生成调用客户端代码
* 自动翻译对应的请求结构体为语言对应结构体
* 按配置要求进行代码检测，如必要性检测、长度检测、Regex格式检测等。
* 按OpenAPI配置检测输出正确性，区分正确输出、错误输出和异常出错。


# 配置文件说明

首次使用后，会在执行目录生成baijiafan.yaml文件，该文件是生成的配置文件，可以微调生成细节。

``` yaml
definitions:
    #是否采用commonjs模式
    - commonjs=false
#目标输出路径
destination: .\docs\.vuepress\theme\layouts
#目标生成语言
language: javascript
#扩展模式最大参数数量
max_arg_num_of_expand_mode: 3
paths:
    /admin/logined:
        get:
            input_mode: ""
    /api/list.{Type}:
        get:
            input_mode: ""
    /service/user/login:
        post:
            input_mode: object
    /service/user/logined:
        get:
            input_mode: ""
    /service/user/supportregister:
        get:
            input_mode: ""
    /system/wx:
        get:
            input_mode: ""
server_no: 0
server_variables: null
source: ..\openapi-client-template\javascript
yaml: "43"
```



## 目前工作进度

| 语言       | 进度     | 帮助文件                         |
| ---------- | -------- | -------------------------------- |
| Javascript | 初步版本已实现 | [Readme](./javascript/Readme.md) |
| Golang     | 开展中   |                                  |
| Java       | 未计划   |                                  |

如果有简单希望体验代码生成的，可以在[百家饭网站](https://rongapi.cn/api/home)体验线上版本，线上版本不能指定自定义参数，但是可以获得按默认配置生成的代码