29 KiB
Tencent is pleased to support the open source community by making APIJSON available.
Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved.
This source code is licensed under the Apache License Version 2.0
APIJSON
🏆 Tencent top 10 open source project, Achieved 5 awards inside & outside Tencent
🚀 A JSON Transmission Protocol and an ORM Library for providing APIs and Documents without writing any code.
A better online document is available at https://apijsondocs.readthedocs.io/
-
1. About
-
2. Server-side deployment
-
3. Client-side deployment
-
4.Contributing
-
5.Versioning
-
6.Author
-
7.Donating
1. About
APIJSON is a JSON based internet communication protocol and an ORM library
that largely simplifies the process of back-end API development.
It also allows users to get data more quickly with self-defined form and fewer endpoints requests.
Features:
For getting data:
You can get any data by defining the specific information you want and send it to the server.
You can get different types of data by making just one request to the server.
It's very convenient and flexible, and dosen't require different API endpoints with multiple requests.
It provides CRUD(read and write), Fuzzy Search, Remote Function Calls, etc.
You can also save duplicate data, see request history, etc.
For API design:
APIJSON largely reduces API developers' workload by reducing most api design and documentation work.
With APIJSON, client developers will no longer be suffered from possible errors in documents,
and it saves communication between server developers and client developers about APIs or documentations.
Server developers no longer need to worry about compatibility of APIs and documents with legacy apps.
Song Firework-Katy Parry(Modified for APIJSON)
Do you ever feel like a backend slave
Repeating CRUD, wanting to make a change?
Do you ever feel, APIs' so paper thin
Like a house of cards, one blow from cavin' in?
Do you ever feel they always complain?
Urging doc and feedback bugs, even ask your refactoring
Do you know that there's still a chance for you?
'Cause there's a powerful tool
You just gotta depend and configure
And let it init
Just start APIs
They are so easy to try
'Cause baby, you're a firework
Come on, show 'em what you're worth
Make 'em go, "Oh, oh, oh"
As you give 'em an A-T-M
Baby, you're a firework
Come on, let them serve themselves
Make 'em go, "Oh, oh, oh"
You're gonna leave 'em all in awe, awe, awe.
Tired with endless arguments about HTTP API dev or use?
Use APIJSON-the ORM for providing infinity codeless CRUD APIs that fit almost all your needs.
Unfold the Power(In Your Soul) with ⭐Star & Clone.
APIJSON Show
Postman test APIJSON
APIAuto test APIJSON
Note: The UI is APIAuto, the URL+JSON is APIJSON
APIJSON: query multi related tables, flexible data structures. APIAuto: multi test accounts, easily share test cases
APIAuto: generate request code for frontend/clients or Python test cases, easily download code
APIAuto: auto save test records, auto generate API doc, requests shortcut, easily replay
APIAuto: auto regression test without code, annotation, comment, etc.)
A picture is worth a thousand words - some basic features show for APIJSON
2.Server-side deployment
You can skip this step and use 'apijson.cn:8080'.
See https://github.com/APIJSON/APIJSON-Demo/blob/master/APIJSON-Java-Server/README-English.md
3. Client-side deployment
You can skip this step and use APIAuto or download App.
See Android, iOS or JavaScript
Download App
Simple demo App for testing APIJSON
APIJSONTest.apk
Complex production App like Twitter tweets
APIJSONApp.apk
4. Contributing
We are always looking for more developers to help implementing new features, fix bugs, etc. Please have a look at the open issues before opening a new one.
Fork the project and send a pull request.
Please also ⭐Star the project!
5. Releases
See the latest release here.
6. Auhtor
Check out the author's github account to see more related projects.
If you have any questions or suggestions, you can create an issue or send me an e-mail.
Users of APIJSON:
https://github.com/Tencent/APIJSON/issues/187
Contributers of APIJSON:
Contributers for the APIJSON core project(6 Tencent engineers, 1 Microsoft engineer, 1 Zhihu architect, 1 NetEase engineer, 1 Zoom engineer, 1 YTO Express engineer, 1 Zhilian engineer, 1 UC student、3 SUSTech student, etc.):
https://github.com/Tencent/APIJSON/blob/master/CONTRIBUTING.md
Authors of other projects for ecosystem of APIJSON(2 Tencent engineers, 1 BAT(Baidu/Alibaba/Tencent) specialist, 1 Microsoft engineer, 1 Bytedance(TikTok) engineer, etc.):
https://github.com/search?o=desc&q=apijson&s=stars&type=Repositories
https://search.gitee.com/?skin=rec&type=repository&q=apijson&sort=stars_count
Thanks to all contributers of APIJSON!
Statistics
Hundreds of employees from big famous companies(Tencent, Google, Microsoft, Amazon, Huawei, Alibaba, Paypal, Meituan, Bytedance, IBM, Baidu, JD, NetEase, Kuaishou, Shopee, etc.) starred,
a lot of employees from big famous companies(Tencent, Huawei, Microsoft, Zoom, etc.) created PR/Issue, thank you all~
