1 Star 1 Fork 60

icewind2021 / jpress-miniprogram-sdk

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

JPress 微信小程序SDK

JPress 是一个使用java开发的类似 WordPress 的程序,详情:https://gitee.com/fuhai/jpress 。 此 SDK 是为了帮助微信小程序开发者能够快速的对接 jpress,调用和操作 jpress 数据。

JPress 同时也是开发者用来开发其他互联网系统的基石,基于 JPress 开发的产品能够快速对接微信公众号和微信小程序等。

JPress 已经内置了完善的 用户管理、权限管理、文章管理、页面管理的基础功能,同时 基于 JFinal 和 Jboot 开发,天生支持微服务的分布式部署,支持任何大流量、大并发项目。同时拥有良好的扩展机制,帮助程序员节约时间和开发成本。

SDK 是基于 Apache 协议开源,因此可以通过此SDK修改扩展到你自己的其他项目里。不用担心任何版权的问题。

JPress 网址: http://jpress.io

SDK 用法

SDK的用法主要分为以下几个步骤:

  • 初始化 SDK
  • 调用 SDK 接口进行数据操作

初始化

SDK 需要在小程序启动的时候进行初始化,例如:

App({
  onLaunch: function () {
       jpress.init({
         host:'http://jpress_web_url.com',
         app_id:'my_app_id',
         app_secret:'my_app_secret'
       })
   }
})   

以上的 my_app_idmy_app_secret 需要在后台填写(后台 -> 系统 -> 接口 ),如下图所示:

小程序用户登录和注册

用户登录

wx.login({
  success: res => {
    jpress.wxLogin(res.code)
  }
})

用户注册

注意:只有该微信用户是第一次进入微信小程序的时候,才会进行用户注册,当用户注册成功后,再次进入,该接口则是读取当前的用户信息进行绑定。

微信小程序布局文件:

<button  open-type="getUserInfo" bindgetuserinfo="getUserInfo"> 
获取用户信息 
</button>

js 处理:

getUserInfo: function(e) {

    //只需要一行代码就可以把当前用户信息注册到jpress系统
    //此时,通过jpress后台就可以查看到该用户信息
    jpress.wxGetUserInfo(e.detail)
}

SDK 方法列表

接口 描述 备注
init 对JPress SDK 进行初始化 在小程序启动的时候调用
createGetRequest 构建一个Get API请求
createPostRequest 构建一个Post API请求
createRequest 构建一个API请求,默认是get请求
wxLogin 进行用户code初始化
wxGetUserInfo 进行用户注册 (如果当前用户没有注册,就会注册一个新的用户;如果用户已经注册,则初始化当前用户信息)
getOption 获取网站配置信息
getUser 通过用户ID获取用户信息
getMyInfo 获取当前登录的用户信息(我的信息)
doUserSave 对用户信息进行保存
getArticle 获取单篇文章信息
getArticleList 获取文章列表(固定数量,默认为10条数据)
getArticlePage 分页加载文章列表
getArticleCategory 获取网站的分类信息
doArticleSave 文章数据更新
getPage 获取单个页面信息
getPageList 获取固定标识的页面列表

获取当前用户信息(自己的信息)

jpress.getMyInfo()
.then(data=>{
    console.log(data)//用户信息
})
.catch(data=>{
    console.log(data.message);//错误信息
})

获取用户信息

获取id=123的用户信息

jpress.getUser(123)
.then(data=>{
    console.log(data)//id=123的用户信息
})
.catch(data=>{
    console.log(data.message);//错误信息
})

保存用户信息

var userData = {
    id:123,
    nickname : "张三",
    email : "xxx@qq.com",  
}

jpress.doUserSave(userData)
.then(data=>{
    //保存成功
})
.catch(error=>{
    console.error(error.message)
})

其他方法参考SDK列表。

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

JPress 微信小程序SDK 展开 收起
JavaScript
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
JavaScript
1
https://gitee.com/icewind2021/jpress-miniprogram-sdk.git
git@gitee.com:icewind2021/jpress-miniprogram-sdk.git
icewind2021
jpress-miniprogram-sdk
jpress-miniprogram-sdk
master

搜索帮助