Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Yao committed Dec 24, 2021
1 parent 3676b54 commit 97b0ee2
Show file tree
Hide file tree
Showing 15 changed files with 92 additions and 39 deletions.
69 changes: 48 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,46 @@
![JSONConverter logo](/Screenshots/JSONConverterLogo.jpg)
![JSONConverter logo](/Screenshots/logo.jpg)

English | [简体中文](./README.zh-CN.md)

JSONConverter
============
JSONConverter is a desktop application for MacOS written in Swift.
Using JSONConverter you will be able to:
* Convert any valid JSON object to a class of one of the currently supported languages.
* Format JSON and display JSON with rich text, user can custom choose style by Highlightr, supports [185 languages and comes with 89 styles](https://highlightjs.org/static/demo/)
* Preview and export the generated rich content
* Change the root class name.
* Set a class name prefix for the generated classes.
* Custom file header include author/date etc.
* automatic hump conversion
* Support i18n(English/Chinese)
* more smart and safe
...
JSONConverter is an auxiliary tool developed for iOS/Flutter/Android/Server on MAC. It can quickly format JSON data and convert and generate corresponding model class attributes. It currently supports Java/Objective-C/Dart/Golang/Swift and popular first Three-party libraries: [SwiftyJSON](https://github.com/SwiftyJSON/SwiftyJSON), [HandyJSON](https://github.com/alibaba/HandyJSON), [ObjectMapper](https://github.com/Hearst -DD/ObjectMapper), you can flexibly choose to build Class/Struct, save the trouble of typing the model by hand, and greatly improve the development efficiency.

Why use JSONConverter
======

| Features | JSONConverter | JSONExport |
| ------ | ------ | ------ |
| Custom configuration | powerful | support |
| Response | promptly | Recently 2019 |
| Open source or free |||
| Dark mode |||
| Rich text display |||
| Automatic hump |||
| Class name anti-weight |||
| Type inference |||
| Integrity check |||
| JSON verification |||
| Class/Struct |||
| Java |||
| Swift |||
| Objective-C |||
| Flutter |||
| Golang |||
| ... | | |


Features
=======
* Quickly convert JSON data to generate model classes and attributes corresponding to the supported languages.
* Format rich text to display JSON data, support [185 languages ​​and 89 styles](https://highlightjs.org/static/demo/)
* Preview and export the generated corresponding rich text model class
* Configure the root class name
* Configuration class prefix
* Custom class file prefix
* Automatic conversion of underscore hump
* globalization
* Array model attribute integrity check

Currently supported languages
=============================
Expand All @@ -27,16 +52,17 @@ Currently supported languages
- 2. Objective-C
- 3. Flutter
- 4. Java
- 5. Golang
- if you have other needs, you can let us know by [issues](https://github.com/DevYao/JSONConverter/issues)

Screenshots
========================
![1.png](/Screenshots/01.png)
![2.png](/Screenshots/02.png)
![3.png](/Screenshots/03.png)
![4.png](/Screenshots/04.png)
![5.png](/Screenshots/05.png)
![6.png](/Screenshots/06.png)
![objc.png](/Screenshots/objc.png)
![swift.png](/Screenshots/swift.png)
![swiftyjson.png](/Screenshots/swiftyjson.png)
![objectmapper.png](/Screenshots/objectmapper.png)
![flutter.png](/Screenshots/flutter.png)
![golang.png](/Screenshots/golang.png)

Installation
============
Expand All @@ -45,17 +71,18 @@ Installation

To Do
=====
* HTTP Request
* Support C Struct
* Support C++ Class/Struct
* Support Kotlin Class/Struct

Flutter model instruction links
Flutter instructions
========================
* [json_serializable](https://github.com/dart-lang/json_serializable)

Final
==========
* The application still in its early stage. Please report any issue so I can improve it.
* The application still in its early stage. Please report any issue so I can improve it, If you like it, please give a star to encourage a wave 😁

License
========================
Expand Down
62 changes: 44 additions & 18 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,36 @@
![JSONConverter logo](/Screenshots/JSONConverterLogo.jpg)
![JSONConverter logo](/Screenshots/logo.jpg)

简体中文 | [English](./README.md)

JSONConverter
==========
JSONConverter是MAC上iOS/Flutter开发的辅助工具,可以快速的格式化JSON数据并转换生成对应的模型类属性,目前支持/Java/Objective-C/Flutter/Swift及目前流行的第三方库: [SwiftyJSON](https://github.com/SwiftyJSON/SwiftyJSON)[HandyJSON](https://github.com/alibaba/HandyJSON)[ObjectMapper](https://github.com/Hearst-DD/ObjectMapper),可以灵活选择构建class/struct,并支持配置类名前缀等,省去手敲模型的麻烦,极大提高开发效率。
=============
JSONConverter是MAC上iOS/Flutter/Android/Server等开发的辅助工具,可以快速的格式化JSON数据并转换生成对应的模型类属性,目前支持Java/Objective-C/Dart/Golang/Swift及流行的第三方库: [SwiftyJSON](https://github.com/SwiftyJSON/SwiftyJSON)[HandyJSON](https://github.com/alibaba/HandyJSON)[ObjectMapper](https://github.com/Hearst-DD/ObjectMapper),可以灵活选择构建Class/Struct,省去手敲模型的麻烦,极大提高开发效率。

应用比较
======

| 特性 | JSONConverter | JSONExport |
| ------ | ------ | ------ |
| 自定义配置 | 丰富 | 一般 |
| 问题响应 | 响应及时 | 最近维护2019年 |
| 开源或免费 |||
| 暗黑模式切换 |||
| 富文本展示 |||
| 自动驼峰 |||
| 类名防重 |||
| 类型推导 |||
| 完整性检查 |||
| JSON校验 |||
| Class/Struct |||
| Java |||
| Swift |||
| Objective-C |||
| Flutter |||
| Golang |||
| ... | | |

功能介绍
============
=======
* 快速的把JSON数据转换生成对应支持的语言的模型类和属性.
* 格式化富文本展示JSON数据,支持[185种语言和89种样式](https://highlightjs.org/static/demo/)
* 预览并导出生成的对应富文本模型类
Expand All @@ -17,6 +39,8 @@ JSONConverter
* 自定义类文件前缀
* 下划线驼峰自动转换
* 国际化
* 数组模型属性完整性检查


当前支持的语言
============
Expand All @@ -28,34 +52,36 @@ JSONConverter
- 2. Objective-C
- 3. Flutter
- 4. Java
- 5. Golang
- 如果你还有其他需要,可以通过[issues](https://github.com/DevYao/JSONConverter/issues)告诉我

应用截图
========================
![1.png](/Screenshots/01.png)
![2.png](/Screenshots/02.png)
![3.png](/Screenshots/03.png)
![4.png](/Screenshots/04.png)
![5.png](/Screenshots/05.png)
![6.png](/Screenshots/06.png)
应用预览
======
![objc.png](/Screenshots/objc.png)
![swift.png](/Screenshots/swift.png)
![swiftyjson.png](/Screenshots/swiftyjson.png)
![objectmapper.png](/Screenshots/objectmapper.png)
![flutter.png](/Screenshots/flutter.png)
![golang.png](/Screenshots/golang.png)

安装说明
============
======
* 使用Xcode Build,拷贝JSONConverter.app 至 Application 文件夹
* 直接下载 [Release Packages](https://github.com/DevYao/JSONConverter/releases)

开发计划
==================
======
* 实现HTTP请求
* 支持 C Struct 转换
* 支持 C++ Struct/Class 转换
* 支持 Kotlin 转换

Flutter 模型使用说明
========================
Flutter 说明
===========
因为Flutter JSON转换功能是配合[json_serializable](https://github.com/dart-lang/json_serializable)使用,具体的使用说明可以查看以下说明
* [Flutter-快速完成JosnModel的转换](https://www.jianshu.com/p/8e22a383bc4b)
* [JSON和序列化](https://flutterchina.club/json/)

声明
========================
因为,并没有在项目中实际使用过[SwiftyJSON](https://github.com/SwiftyJSON/SwiftyJSON)[ObjectMapper](https://github.com/Hearst-DD/ObjectMapper)等库,所以并不知道初始化方法构建的是否合理,如果你有更好的建议,欢迎留言,大家共同进步,谢谢!,如果喜欢,请给一个star,鼓励一波,哈哈哈哈😁
===
因为,有些语言或框架并没有实际使用过,所以并不知道模型构建的是否合理,如果你有更好的建议,欢迎提PR/Issues,大家共同进步,谢谢!,如果喜欢,请给一个star,鼓励一波,哈哈哈哈😁
Binary file removed Screenshots/01.png
Binary file not shown.
Binary file removed Screenshots/02.png
Binary file not shown.
Binary file removed Screenshots/03.png
Binary file not shown.
Binary file removed Screenshots/04.png
Binary file not shown.
Binary file removed Screenshots/05.png
Binary file not shown.
Binary file removed Screenshots/06.png
Binary file not shown.
Binary file added Screenshots/flutter.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Screenshots/golang.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
Binary file added Screenshots/objc.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Screenshots/objectmapper.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Screenshots/swift.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Screenshots/swiftyjson.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 97b0ee2

Please sign in to comment.