Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/blesstosam/weibo-node-api

a nodejs weibo api
https://github.com/blesstosam/weibo-node-api

api nodejs typescript

Last synced: about 4 hours ago
JSON representation

a nodejs weibo api

Host: GitHub
URL: https://github.com/blesstosam/weibo-node-api
Owner: blesstosam
License: mit
Created: 2019-10-04T14:17:04.000Z (about 5 years ago)
Default Branch: master
Last Pushed: 2020-08-31T01:46:07.000Z (about 4 years ago)
Last Synced: 2024-11-08T08:54:35.750Z (10 days ago)
Topics: api, nodejs, typescript
Language: TypeScript
Size: 23.4 KB
Stars: 6
Watchers: 3
Forks: 1
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG
- License: LICENSE

Awesome Lists containing this project

README

        [![CircleCI](https://circleci.com/gh/puncsky/typescript-starter.svg?style=svg)](https://circleci.com/gh/puncsky/typescript-starter)

# Weibo-node-api

> 封装了微博 api，在 [node-weibo](https://github.com/vczero/node-weibo) 的基础上用 typescript 重写，并增加了一些新的 api。

> 🙏[vczero](https://github.com/vczero) !!!

#### 安装

```

npm install weibo-node-api

```

#### 一、API 使用说明

    (1)阅读新浪微博的API文档 http://open.weibo.com/wiki/%E5%BE%AE%E5%8D%9AAPI

    (2)新建实例

    const weibo = new Weibo(opts)

    (3)请求授权接口作为单独的接口，即在weibo实例上

    weibo.authorize()

    (4)浏览：http://open.weibo.com/wiki/%E5%BE%AE%E5%8D%9AAPI

       +---------

       比如1：需要使用“OAuth2授权接口”，点击链接到页面底部，看到“OAuth2”，那么OAuth2就是一个类，

       weibo.OAuth2.

       weibo.OAuth2的获取access_token的方法是：weibo.OAuth2.access_token;

       +---------

       比如2：需要使用“微博接口”,那么该类的名称是Statuses.

       则返回最新的公共微博是：public_timeline.

       整个方法的调用是weibo.Statuses.public_timeline.

       +---------

       所有类和函数命名方式尊重新浪微博API方式，以此类推.

    (5)所有方法两个参数，第一参数是该接口的参数(json对象格式，不含appKey, appSecret, access_token等参数)

#### 二、example 说明

    /*

    +-------------------------------------------------

    (1)注册账号：http://open.weibo.com/

    (2)配置回调url地址和安全域名地址（这两点非常重要）。

    +-------------------------------------------------

    */

    const Weibo = require('weibo-node-api');

    // 首次调用接口前需初始化Weibo类，传入配置信息

    const weibo = new Weibo({

      appKey: "2178887180",

      appSecret: "bdb36bac9ce99f78aeb6a2f204c9b8e1",

      redirectUrl: "http://blesstosam.github.io",

      secureDomain: "http://www.github.com"

    });

    /*

    +-------------------------------------------------

    1：开启微博认证

    启动认证后，将在浏览器器打开一个窗口，url中含有code参数

    +-------------------------------------------------

    */

    weibo.authorize();

    /*

    +--------------------------------------------------

    2：需要获取access_token

    +---------------------------------------------------

    */

    const res = await weibo.OAuth2.access_token(

    {

      code: "3713366ba477464c7250d41794404c7b",

      grant_type: "authorization_code"

    });

    console.log(res)

    /*

    +--------------------------------------------------

    例3：调用API发微博

    +---------------------------------------------------

    */

    const resp = resweibo.Statuses.share(

      {

        source: weibo.opts.appKey,

        access_token: data.access_token,

        status: encodeURI(`just for test! ${weibo.opts.secureDomain}`)

      });

    console.log(resp)

#### 三、测试 appkey

(1)如需开发，请自行申请微博开放平台的开发者账号信息。  

(2)提供 appkey 仅为测试所用，勿用于实际开发，否则我更改了账号信息会影响您的应用正常使用。  

(3)测试的应用信息如下。

```

{

  "appKey":"2178887180",

  "appSecret":"bdb36bac9ce99f78aeb6a2f204c9b8e1",

  "redirectUrl":"127.0.0.1:3000"

}

```

#### 四、微博 API 文档

[微博 API 文档](https://open.weibo.com/wiki/%E5%BE%AE%E5%8D%9AAPI)

#### 五、吐槽 - 微博的 api 真是难用啊！