fjc0k / Yapi To Typescript
Licence: mit
根据 YApi 或 Swagger 的接口定义生成 TypeScript/JavaScript 的接口类型及其请求函数代码。
Stars: ✭ 161
Programming Languages
javascript
184084 projects - #8 most used programming language
typescript
32286 projects
Labels
Projects that are alternatives of or similar to Yapi To Typescript
Swagger to uml
Convert OpenAPI specifications (a.k.a. Swagger) to PlantUML diagrams
Stars: ✭ 144 (-10.56%)
Mutual labels: swagger
Prism
Turn any OpenAPI2/3 and Postman Collection file into an API server with mocking, transformations and validations.
Stars: ✭ 2,484 (+1442.86%)
Mutual labels: swagger
Kotlin Openapi Spring Functional Template
🍃 Kotlin Spring 5 Webflux functional application with api request validation and interactive api doc
Stars: ✭ 159 (-1.24%)
Mutual labels: swagger
Core
The server component of API Platform: hypermedia and GraphQL APIs in minutes
Stars: ✭ 2,004 (+1144.72%)
Mutual labels: swagger
Raml Server
run a mocked server JUST based on a RAML API's definition .. zero coding
Stars: ✭ 158 (-1.86%)
Mutual labels: swagger
Tropical Fish
Pragmatic 风格的 Java EE 后端开发脚手架,开箱即用。基于 SpringBoot,技术选型采用主流的框架(Mybatis-Plus,Redisson,Xxl-job,Swagger)。项目特点:自定义查询语法, 可以自由组装查询条件查询数据,配合代码生成模块,提高研发效率;自定义 service 方法级别的文档生成规则,在业务方法增加必要的注解,可生成方法调用树,快速把握复杂代码业务逻辑。
Stars: ✭ 142 (-11.8%)
Mutual labels: swagger
Swagger Diff
🎿 Compare two swagger API specifications(1.x or v2.0)
Stars: ✭ 161 (+0%)
Mutual labels: swagger
Swagger meqa
Auto generate and run tests using swagger/OpenAPI spec, no coding needed
Stars: ✭ 151 (-6.21%)
Mutual labels: swagger
Study
全栈工程师学习笔记;Spring登录、shiro登录、CAS单点登录和Spring boot oauth2单点登录;Spring data cache 缓存,支持Redis和EHcahce; web安全,常见web安全漏洞以及解决思路;常规组件,比如redis、mq等;quartz定时任务,支持持久化数据库,动态维护启动暂停关闭;docker基本用法,常用image镜像使用,Docker-MySQL、docker-Postgres、Docker-nginx、Docker-nexus、Docker-Redis、Docker-RabbitMQ、Docker-zookeeper、Docker-es、Docker-zipkin、Docker-ELK等;mybatis实践、spring实践、spring boot实践等常用集成;基于redis的分布式锁;基于shared-jdbc的分库分表,支持原生jdbc和Spring Boot Mybatis
Stars: ✭ 159 (-1.24%)
Mutual labels: swagger
Go Micro Boilerplate
The boilerplate of the GoLang application with a clear microservices architecture.
Stars: ✭ 147 (-8.7%)
Mutual labels: swagger
Psswagger
The cmdlet generator from OpenAPI (f.k.a Swagger) specification
Stars: ✭ 160 (-0.62%)
Mutual labels: swagger
Swagger Axios Codegen
swagger client to use axios and typescript
Stars: ✭ 143 (-11.18%)
Mutual labels: swagger
Ginrpc
gin auto binding,grpc, and annotated route,gin 注解路由, grpc,自动参数绑定工具
Stars: ✭ 157 (-2.48%)
Mutual labels: swagger
Ruoyi Cloud
(RuoYi)官方仓库 基于Spring Boot、Spring Cloud & Alibaba的分布式微服务架构权限管理系统
Stars: ✭ 160 (-0.62%)
Mutual labels: swagger
Spring Boot Examples
个人学习 SpringBoot2.x 写的一些示例程序,目前正在持续更新中.....
Stars: ✭ 159 (-1.24%)
Mutual labels: swagger
YApi to TypeScript
根据 YApi 或 Swagger 的接口定义生成 TypeScript/JavaScript 的接口类型及其请求函数代码。
钉钉扫码加入交流群:
预览
特性
- 支持多服务器、多项目、多分类
- 支持预处理接口信息
- 可自定义类型或函数名称
- 完整的注释
- 支持生成 React Hooks 的请求代码
- 支持参数路径
- 支持上传文件
- 支持生成 JavaScript 代码
- 支持 Swagger
环境要求
Node >= 10.19.0
YApi >= 1.5.12
安装
# yarn
yarn add yapi-to-typescript
# 或者,npm
npm i yapi-to-typescript --save
使用
yapi-to-typescript
基于当前目录下的 ytt.config.{ts,js}
配置文件进行相关操作。
生成配置文件
使用命令 ytt init
可在当前目录自动创建配置文件 ytt.config.{ts,js}
,如果配置文件已存在,将会询问你是否覆盖:
# yarn
yarn ytt init
# 或者,npm
npx ytt init
修改配置文件
打开当前目录下的 ytt.config.{ts,js}
配置文件,直接修改即可。查看配置说明
生成代码
直接执行命令 ytt
即可抓取 YApi
的接口定义并生成相应的 TypeScript
/JavaScript
代码:
# yarn
yarn ytt
# 或者,npm
npx ytt
配置
概论
从实质上而言,配置就是一个服务器列表,各个服务器又包含一个项目列表,各个项目下都有一个分类列表,其类型大致如此:
type Servers = Array<{
projects: Array<{
categories: Array<{
// ...
}>
}>
}>
// 配置实质是一个服务器列表
type Config = Servers
因此,你可分别在 服务器级别
、项目级别
、分类级别
进行相关配置,如果不同级别存在相同的配置项,低级别的配置项会覆盖高级别的配置项,也就是说:
- 如果存在相同的配置项,
分类级别
的配置会覆盖项目级别
、服务器级别
的配置项; - 如果存在相同的配置项,
项目级别
的配置会覆盖服务器级别
的配置项。
配置项
具体配置项见:API 文档。
参与贡献
为避免无用功,功能新增或变更请提 issue 由维护者评估后再决定是否继续;功能修复以及经评估可行的功能新增或变更请提 PR。
- 安装依赖:
yarn
- 运行测试:
yarn test
许可
MIT (c) Jay Fong
Note that the project description data, including the texts, logos, images, and/or trademarks,
for each open source project belongs to its rightful owner.
If you wish to add or remove any projects, please contact us at [email protected].